aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorBoris Kolpackov <boris@codesynthesis.com>2015-05-29 18:31:08 +0200
committerBoris Kolpackov <boris@codesynthesis.com>2015-05-29 18:31:08 +0200
commit75cb85e0cfa66480492b80ada19bd5a02ea12305 (patch)
tree78b4761ae9421cb012bc2b92b600ed1830c0be5e /README
Add git helper scripts
Diffstat (limited to 'README')
-rw-r--r--README22
1 files changed, 22 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..68e1a01
--- /dev/null
+++ b/README
@@ -0,0 +1,22 @@
+Set of git helper scripts for working with multi-repository projects.
+
+Setup:
+
+1. There needs to be etc/git/modules file that defines all the
+ repositories.
+
+2. You would normall checkout the repository with these scripts
+ next to your other repositories in the project and then add
+ it to the modules file above (so that when you do ./pull.sh,
+ you get script updates as well).
+
+3. In the root of your project (i.e., where you have git, etc,
+ and your project-specific repositories), create sym-links
+ to the scripts. E.g.,
+
+ ln -s git/*.sh ./
+
+ You may want to remove the symlink to stash.sh so that stat.sh
+ (the most frequently ran command) auto-completes on 's' (i.e.,
+ you run it by typing "./a<TAB><ENTER>"). In this case you would
+ run stash.sh as git/shash.sh.