0
@@ -1,74 +1,49 @@
0
-= README
0
+Braid is a simple tool to help track git and svn vendor branches in a git
0
+repository.
0
 
0
-Braid is a simple tool for managing vendor branches across different SCMs.
0
+In purpose, it's similar to piston, but it's especially built on top of git
0
+commands. This allows better integration with git and easier management of
0
+merges.
0
 
0
-http://evil.che.lu/projects/braid
0
+The braid homepage is:http://evil.che.lu/projects/braid.
0
 
0
-You'll need a rather recent version of git, most likely something after 1.5.4.
0
+Braid is "hosted on github":http://github.com/evilchelu/braid.
0
 
0
-If you're on OS X, git from macports is at version 1.5.3.7 and braid won't work with that.
0
-There a patch in the macports trac to allow you to get git-core 1.5.4.2, here (thanks jakehow):
0
-http://trac.macosforge.org/projects/macports/ticket/13956
0
+*NOTE:* You will need at least git 1.5.4.5+ to run braid. You'll also need the
0
+open4 and main gems.
0
 
0
-= INSTALLING FORM RUBYGEMS
0
+h3. Install with rubygems
0
 
0
-# gem not published yet. please install from git
0
-sudo gem install braid
0
+  gem sources -a http://gems.github.com/  # only need to do this once
0
+  gem install evilchelu-braid
0
 
0
-= INSTALLING FROM GIT
0
+h3. Get it from the git repository
0
 
0
-# install deps
0
-sudo gem install main
0
-sudo gem install open4
0
+Get a clone of the git repository using:
0
 
0
-git clone git://github.com/evilchelu/braid.git
0
-cd braid
0
-rake install_gem
0
+  git clone git://github.com/evilchelu/braid.git
0
+  cd braid
0
+  rake install_gem
0
+  braid --help # see usage
0
 
0
-= USAGE
0
+h3. Usage
0
 
0
-# create a git repo
0
-git init moo
0
-cd moo
0
+  braid help
0
+  braid help COMMANDNAME
0
 
0
-# ideally you will also do these, but they are just good practices
0
-git config --global merge.summary true
0
-git checkout -b localwork
0
+For more usage examples, documentation, feature requests and bug reporting,
0
+check out the "braid wiki":http://github.com/evilchelu/braid/wikis.
0
 
0
-# adding mirrors
0
-braid add git://blah
0
-braid add svn://muh
0
-gitk braid/track
0
-git merge braid/track
0
+h3. Contributing
0
 
0
-# updating mirrors
0
-braid update muh
0
-braid update
0
-git merge braid/track
0
+If you want to send a patch in, please fork the project on github, commit your
0
+changes and send a pull request.
0
 
0
-# removing mirrors
0
-braid remove blah
0
-braid remove muh
0
-git merge braid/track
0
+h3. Mad props
0
 
0
-= MORE USAGE
0
+Braid used to be quite lame before "Norbert Crombach":http://primetheory.org/
0
+("github":http://github.com/norbert) resuscitated it by contribuing a bunch of
0
+code.
0
 
0
-Braid stores it's metadata in a file called ".braids" located in the current directory where braid is run.
0
-
0
-For full usage docs run:
0
-
0
-braid help
0
-braid help COMMANDNAME
0
-
0
-= POSSIBLE PROBLEMS
0
-
0
-In a multiuser setup people won't have all the remote branches setup. But nothing is really lost, yet.
0
-
0
-Theoretically if you add the same remotes on other checkout and set the branches correctly things could be made to just work(TM).
0
-
0
-= ISSUES
0
-
0
-Braid barely works and you'll definitely encounter bugs. Help is appreciated :).
0
-
0
-For now, known issues and feature requests are stored in the TODO.txt file in the root of the braid checkout.
0
+He rocks! Go buy him a beer. 
0