Add README-GIT on using this project with git (it has submodules)

1 files changed, 19 insertions, 0 deletions

diff --git a/README-GIT b/README-GIT
new file mode 100644
index 0000000..c6808b7
--- /dev/null
+++ b/README-GIT
@@ -0,0 +1,19 @@
+This repository uses git submodules, so watch out! Before working with this
+repository, make sure you do:
+
+  git config --global fetch.recurseSubmodules on-demand
+  git config --global status.submoduleSummary true
+  git config --global diff.submodule log
+
+To clone this repository, use --recursive:
+
+  git clone --recursive ...
+
+To pull, you *must* run two commands:
+
+  git pull
+  git submodule update --init --recursive
+
+To update submodules to the latest master (remember to commit afterwards):
+
+  git submodule update --remote [submodule]