Brief docs.

diff --git a/scripts/README.markdown b/scripts/README.markdown
new file mode 100644 (file)
index 0000000..c00bec2
--- /dev/null
+++ b/scripts/README.markdown
@@ -0,0 +1,66 @@
+
+gc-add
+======
+
+`gc-add <path>...`
+
+* If no arguments, adds all new, adds all changed, removes all removed
+* If arguments, passes through to `git add`
+
+gc-checkout
+===========
+
+`gc-checkout <branch>`
+
+* If `branch` already exists locally, check it out
+* If `branch` already exists remotely, check it out
+* If `branch` is new, create it locally and remotely
+
+gc-commit
+=========
+
+`gc-commit`
+
+* Passes through to `git commit`
+
+gc-diff
+=======
+
+`gc-diff`
+
+* Passes through to `git diff`
+
+gc-pull
+=======
+
+`gc-pull`
+
+* Passes through to `git pull` but with `--rebase` flag
+
+gc-push
+=======
+
+`gc-push`
+
+* Pushes only the current branch to `origin`
+
+gc-remerge
+==========
+
+* Work in progress, not done
+
+gc-rm
+=====
+
+`gc-rm`
+
+* Passes through to `git rm`
+
+gc-status
+=========
+
+`gc-status`
+
+* Passes through to `git status`
+
+

diff --git a/scripts/gc-pull b/scripts/gc-pull
index 4b04d3a..1844725 100644 (file)
--- a/scripts/gc-pull
+++ b/scripts/gc-pull
@@ -1,4 +1,7 @@
 #!/bin/sh
 
+#
+# Note: we should use `git pull --rebase origin <branch>`?
+#
 git pull --rebase $*