From d7ba6ddcc8f2e4cd26807b83c0bb1ab647e53e76 Mon Sep 17 00:00:00 2001
From: weru <onewesh@gmail.com>
Date: Tue, 06 Oct 2020 20:41:51 +0000
Subject: [PATCH] update

---
 exampleSite/content/docs/getting-started.md |   54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 54 insertions(+), 0 deletions(-)

diff --git a/exampleSite/content/docs/getting-started.md b/exampleSite/content/docs/getting-started.md
index 65b2e4f..0b4d001 100755
--- a/exampleSite/content/docs/getting-started.md
+++ b/exampleSite/content/docs/getting-started.md
@@ -15,3 +15,57 @@
 
 For comprehensive Hugo documentation, see [gohugo.io](https://gohugo.io/).
 
+## Run your site with compose theme
+
+You could go with the options right below.
+
+### Option 1 (my favorite)
+
+This option enables you to load compose theme as a hugo module.
+
+```bash
+git clone https://github.com/onweru/compose/
+cd compose/exampleSite/
+hugo server
+```
+
+> There's one drawback to this technique. Your site would always use the most up-to-date version of the theme. This might break your site if there are drastic changes that you don't like.
+
+You can neutralize that drawback by forking the repo instead and following the same approach. Be sure the edit the `theme = ["github.com/onweru/compose"]` from the config.toml file appropriately.
+
+> ⚠️ If you choose __Option 2__ or __Option 3__ below, ensure you edit [these lines in the config.toml file](https://github.com/onweru/compose/blob/b3e30e0816621223224897edc45eeeabd0d9cd16/exampleSite/config.toml#L4-L7) as advised on the comments
+
+### Option 2 (recommended)
+
+Generate a new Hugo site and add this theme as a Git submodule inside your themes folder:
+
+```bash
+hugo new site yourSiteName
+cd yourSiteName
+git init
+git submodule add https://github.com/onweru/compose/ themes/compose
+cp -a themes/compose/exampleSite/* .
+```
+
+Then run
+
+```bash
+hugo server
+```
+
+Hurray!
+
+### Option 3 (Great for testing quickly)
+
+You can run your site directly from the `exampleSite`. To do so, use the following commands:
+
+```bash
+git clone https://github.com/onweru/compose/
+cd compose/exampleSite/
+hugo server --themesDir ../..
+```
+
+> Although, option 3 is great for quick testing, it is somewhat problematic when you want to update your theme. You would need to be careful not to overwrite your changes.
+
+Once set, jump over to the `config.toml` file and start [configuring](#configuration) your site.
+

--
Gitblit v1.10.0