From: Stephen Haberman <stephen@exigencecorp.com>
Date: Wed, 12 Nov 2008 05:54:33 +0000 (-0600)
Subject: Moving the readme and making it a project-wide overview.
X-Git-Url: http://git.droids-corp.org/?p=git-central.git;a=commitdiff_plain;h=342f4eef37971bfa36468fec39aae024e8c8264e

Moving the readme and making it a project-wide overview.
---

diff --git a/README.markdown b/README.markdown
new file mode 100644
index 0000000..e787f88
--- /dev/null
+++ b/README.markdown
@@ -0,0 +1,34 @@
+
+Overview
+========
+
+Tweaks for using git in a corporate/close-team environment.
+
+Server-side Hooks
+=================
+
+See the individual scripts for documentation, but an overview:
+
+* post-receive-assign-commitnumbers: makes Subversion-like monotonically increasing commit numbers for every commit
+* post-receive-email: contrib email script with customizations for stuff like combined diffs
+* post-receive-git-config: auto-updates the git config+hooks on the server when updated in the repo
+* post-receive-hudson: auto-creates new jobs in Hudson when branches in git are created
+* post-receive-trac: updates trac tickets with messages referencing the commits
+* update-allow-tags-branches: contrib/example branch/tag enforcement script with customizations
+* update-ensure-follows: allows nomination of special branches (e.g. stable) that everyone must have merged
+* update-ensure-ticket-reference: enforces ticket references in commit messages (e.g. for trac)
+* update-lock-check: enforces locked/preserved branches
+* update-stable: enforces proper movement of stable
+
+Client-side Hooks
+=================
+
+* commit-msg-trac: enforces ticket references in commit messages
+
+Scripts
+=======
+
+* checkout: `checkout <branch>` does the right thing for creating/tracking a new or existing remote branch
+* push: pushes only the current branch to origin
+* pull: pulls changes down but with rebase-i-p (instead of merge) to avoid same-branch merges and commit replays
+
diff --git a/scripts/README.markdown b/scripts/README.markdown
deleted file mode 100644
index 8630c70..0000000
--- a/scripts/README.markdown
+++ /dev/null
@@ -1,24 +0,0 @@
-
-checkout
-========
-
-`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
-
-pull
-====
-
-`pull`
-
-* Passes through to `git pull` but with `--rebase` flag
-
-push
-====
-
-`push`
-
-* Pushes only the current branch to `origin`
-