Verified Commit 1694fa9b authored by Adam Caprez's avatar Adam Caprez
Browse files

README fixes.

parent 091e67e2
......@@ -19,10 +19,11 @@ edit/create content, and preview your changes locally before creating the MR/PR.
### Setup your environment
#### Clone the repo and create a new branch
#### Clone the repo (including submodules) and create a new branch
Clone the repo somewhere convenient. Run `git checkout -b <mybranch>` to create a new
branch for your changes.
Clone the repo somewhere convenient. The DocDock theme is provided via a git submodule,
so after cloning, run `git submodule update --init --recursive` in the root of the repo.
Run `git checkout -b <mybranch>` to create a new branch for your changes.
#### Download and install Hugo
**Note: The DocDock template currently has errors with the recently released Hugo v0.50. Use v0.49.2 instead until there is a fix.**
......@@ -71,7 +72,7 @@ Once that is done, run the command:
```
hugo server -b http://<instance IP> --bind <instance IP>
```
where <instance IP> is the 10.71.x.x address of your instance.
where *\<instance IP\>* is the 10.71.x.x address of your instance.
You should now be able to preview the website by going to `http://<instance IP>:1313` in your web
browser.
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment