aboutsummaryrefslogtreecommitdiff
path: root/README-GIT
diff options
context:
space:
mode:
authorBoris Kolpackov <boris@codesynthesis.com>2015-11-28 10:19:04 +0200
committerBoris Kolpackov <boris@codesynthesis.com>2015-11-28 10:19:04 +0200
commitc633f4619712a45c6f4a79eeb47891c803656b46 (patch)
tree7ff251e03bbdedfbefe71dc8e358f2f71a85552c /README-GIT
parent5a7f8ab7cb9b4e71d95a8cd89481e099f7e6dd71 (diff)
Add README-GIT on using this project with git (it has submodules)
Diffstat (limited to 'README-GIT')
-rw-r--r--README-GIT19
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]