Document submodules in README.md

From a fresh clone of the rook source, you have to
update the git submodules before building rook.

Fix a bad reference to build/clean, it should
be build/reset
This commit is contained in:
David Borman
2016-12-29 14:43:31 -06:00
parent 6c4f2b6b5e
commit 4d47ab7ede
+11 -1
View File
@@ -15,6 +15,16 @@ A capable machine with Docker installed locally:
We do not currently support building on a remote docker host.
### Update the git submodules
Rook has many git submodules, and before you can
build Rook you need to initialize them:
```
git submodule sync --recursive
git submodule update --recursive --init
```
## Using the Build Container
To run a command inside the container:
@@ -55,7 +65,7 @@ You shouldn't have to do this often unless something is broken or stale with you
build container:
```
build/clean
build/reset
```
## Releasing