# HG changeset patch
# User Jeff Hammel <jhammel@mozilla.com>
# Date 1279745386 25200
# Node ID 0bfbd062765dded10aee7be87270ee3852689f28
# Parent  190ce22e7e83d5ec43b4de39fe6b60d744593bc2
add a README

diff -r 190ce22e7e83 -r 0bfbd062765d README.txt
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.txt	Wed Jul 21 13:49:46 2010 -0700
@@ -0,0 +1,19 @@
+gut
+===
+
+gut is a particular workflow for github.  It works like this:
+
+ 0. It assumes you've already cloned the master repo
+
+ 1. Use `gut feature <name>` to create the feature branch you care
+ about.  For systems with bug numbers, it is recommended to create a
+ branch with the bug number name (e.g. `gut feature bug-123456`)
+
+ 2. Do your development.  Use git like you normally would during a
+ normal development cycle for commiting, etc.
+
+ 3. When it comes time to make a patch, run `gut patch`.  This will
+ generate a .diff file based on your feature branch name and output a
+ combined log for the branch to the console.
+
+ 4. Apply the patch to the master and push it.