summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2017-07-18 10:50:59 +0200
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2017-07-18 10:50:59 +0200
commita2fb8150c3b2451c0efe173c8c1439946558f865 (patch)
treed3360ae3a3c3a75e47bc868008c442de9a7d3991 /README.md
parent73273d4e8138ca7ac60e8201618b1b81da64e92b (diff)
Add some README info about the docs repo
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index e5591d5e0..30bfa8b10 100644
--- a/README.md
+++ b/README.md
@@ -64,6 +64,20 @@ Once the `get` completes, you should find your new `hugo` (or `hugo.exe`) execut
To update Hugo’s dependencies, use `go get` with the `-u` option.
go get -u -v github.com/gohugoio/hugo
+
+## The Hugo Documentation
+
+The Hugo documentation now lives in its own repository, see https://github.com/gohugoio/hugoDocs. But we do keep a version of that documentation as a `git subtree` in this repository. To build the sub folder `/docs` as a Hugo site, you need to clone this repo with submodules:
+
+```bash
+git clone --recursive git@github.com:gohugoio/hugo.git
+```
+
+Or after you have cloned it you can do:
+
+```bash
+git submodule update --init
+```
## Contributing to Hugo