From 4d47ab7edef82eefa0b90e1c70d763896551ea6c Mon Sep 17 00:00:00 2001
From: David Borman <david.borman@quantum.com>
Date: Thu, 29 Dec 2016 14:34:10 -0600
Subject: [PATCH] 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
---
 build/README.md | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

diff --git a/build/README.md b/build/README.md
index 773753fa6..b188a7ad5 100644
--- a/build/README.md
+++ b/build/README.md
@@ -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