midgard/zeus.ugent.be
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Document submodule usage in README

Browse source
This commit is contained in:
Rien Maertens 2018-12-29 18:00:20 +01:00
parent 3860c08556
commit b1b3c46c04
No known key found for this signature in database
GPG key ID: 10C6D8C91DE58E4A
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -45,6 +45,14 @@ bundle exec nanoc live
Go to <http://localhost:3000> to view the site! When developing, the site gets regenerated when editing files. A simple refresh will show the new changes.
### Optional: install submodules
Our official meeting reports are added as a submodule so they update automatically. For normal development, it is not required to initialize these. But if you want to deploy to production (or test the report generation), you will have to initialize the submodule.
```bash
git submodule update --init --recursive
```
### Deploying
The latest and greatest builds on master get deployed automatically using [travis](https://travis-ci.org).