diff options
author | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2017-07-18 11:54:47 +0300 |
---|---|---|
committer | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2017-07-18 11:54:47 +0300 |
commit | cfe751dbf59e60635f83b31da5eaa0a3f1923610 (patch) | |
tree | 580f96198c7ae73e3a10ee74c189d1f315c936b3 /README.md | |
parent | b0470688f14bc964f4928a812f4c3dbd6123e2e7 (diff) |
Add some build info to README
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 19 |
1 files changed, 12 insertions, 7 deletions
@@ -2,12 +2,17 @@ Documentation site for [Hugo](https://github.com/gohugoio/hugo), the very fast and flexible static site generator built with love in GoLang. -## Branches +## Build -* The `master` branch is the **current Hugo version** and will be auto-deployed to [gohugo.io/](https://gohugo.io/). -* Anything not relevant to the current Hugo version goes into the `dev` branch. -* Changes in [hugo/docs](https://github.com/gohugoio/hugo/tree/master/docs) will, in general, be merged once every release, but can be manually merged/cherry picked if needed. This goes both ways. -* All contributions that is not tightly coupled with code changes, should be made directly to `hugoDocs`. -* But we also merge PRs into [hugo/docs](https://github.com/gohugoio/hugo/tree/master/docs), but preferably changes that is related to the code in the PR itself +To view the documentation site locally, you need to clone this repository with submodules: -To summarize, we have two branches in this repository: `master` (current Hugo) and `dev` (next Hugo). +```bash +git clone --recursive https://github.com/gohugoio/hugoDocs.git +``` + +Or if you already have a clone locally: + +```bash +git submodule update --init +``` +Also note that the documentation version for a given version of Hugo can also be found in the `/docs` sub-folder of the [Hugo source repository](https://github.com/gohugoio/hugo).
\ No newline at end of file |