Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/thingsym/hugo-theme-techdoc.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorthingsym <thingsym@gmail.com>2020-11-05 11:54:42 +0300
committerthingsym <thingsym@gmail.com>2020-11-05 11:54:42 +0300
commit0975f772acb9a808c0560a2faa268981249eee72 (patch)
tree3480093a44e1147073f75b9352ceebb4724db2e7 /README.md
parentae5949872ceb2fb7b7d1ce3484060107bbfffa30 (diff)
docs: edit README
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 14 insertions, 5 deletions
diff --git a/README.md b/README.md
index ffc03a1..dccbdd1 100644
--- a/README.md
+++ b/README.md
@@ -53,16 +53,25 @@ Hugo minimum version: 0.60.0
Default Markdown parser library `Goldmark` compatible
-### Download Hugo theme
+### Install Hugo theme on your project
-If you have git installed, you can do the following at the command-line-interface within the Hugo directory:
+If you have git installed, you can include hugo-theme-techdoc repository into your core repository as submodule using `git submodule` within your project directory.
```
-cd themes
-git clone https://github.com/thingsym/hugo-theme-techdoc.git
+cd your_project
+git submodule add https://github.com/thingsym/hugo-theme-techdoc.git themes/hugo-theme-techdoc
```
-For more information read [the Hugo documentation](https://gohugo.io/themes/installing-and-using-themes/).
+For more information read [the Hugo documentation](https://gohugo.io/getting-started/quick-start/).
+
+### Download Hugo theme on your project
+
+If you have git installed, you can do the following at the command-line-interface within your project directory.
+
+```
+cd your_project/themes
+git clone https://github.com/thingsym/hugo-theme-techdoc.git
+```
### Configure