updated readme with markdown syntax and instructions for installing the patched xmloutput plugin for bazaar

Author: jared

README

@@ -1,4 +1,4 @@
-= Ohloh SCM
+# Ohloh SCM
 
 The Ohloh source control management library
 
@@ -16,7 +16,7 @@ GNU General Public License for more details.
 You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-== Overview
+## Overview
 
 Ohloh SCM is an abstraction layer for source control management systems,
 allowing an application to interoperate with various SCMs using a
@@ -25,7 +25,7 @@ single interface.
 It was originally developed at Ohloh, and is used to generate
 the reports at www.ohloh.net.
 
-== System Requirements
+## System Requirements
 
 Ohloh SCM is developed on Mac OS X 10.5 and Ubuntu 6.06 LTS. Other Linux
 environments should also work, but your mileage may vary.
@@ -47,16 +47,43 @@ hg 1.1.2
 If you are using CVS instead of CVSNT, you can potentially try creating
 a shell alias or symlink mapping 'cvsnt' to 'cvs'.
 
-== Running
+## Running
+
+Ensure that cvsnt, svn, svnadmin, svnsync, git, and hg are all on your path. You'll also need to ensure that you have the xmloutput plugin installed for bazaar.
+
+### Installing The XmlOutput Plugin
+    $ cd ~
+    $ mkdir .bazaar
+    $ cd .bazaar
+    $ mkdir plugins
+    $ cd plugins
+
+Now checkout the latest version of the xmloutput plugin (0.8.8 as of 11/21/2011). 
+
+    $ bzr branch lp:~amujumdar/bzr-xmloutput/emit_authors
+
+The default checkout directory is poorly named and bazaar will complain about this unless it is renamed.
+
+    $ mv emit_authors xmloutput
+
+Now you just need to install the xmloutput plugin
+
+    $ cd xmloutput
+    $ python setup.py build_ext -i
+
+Verify that the plugin was installed correctly
+
+    $ bzr plugins
+
+You should see some text like "xmloutput 0.8.8"
 
-Ensure that cvsnt, svn, svnadmin, svnsync, git, and hg are all on your path.
 Then you can run the unit tests:
 
-$ rake
+    $ rake
 
 You can load the library into your own Ruby application by requiring lib/scm.rb.
 
-= Functionality
+# Functionality
 
 For each tracked repository, Ohloh uses the SCM library to maintain a private
 local mirror. The SCM library hides the differences between source control
@@ -74,27 +101,23 @@ tasks on the local mirror:
 
 1. Pull changes -- From a remote repository URL, pull any changes to the local
 mirror. This step may involve conversion from one system to another.
-
 2. Push changes -- From the local mirror, push any changes to another Ohloh
 server. This is required to create backup copies and perform load balancing on
 the Ohloh cluster, and typically occurs over ssh.
-
 3. Commit log -- Given the last known commit, report the list of new commits,
 if any, including their diffs.
-
 4. Cat file or parent -- Given a commit, return either the contents of a
 single file, or that file's previous contents.
-
 5. Export tree -- Given a commit, export the entire contents of the source tree
 to a specified temp directory.
 
 The adapter must also implement validation routines used to filter user inputs
 and confirm the presence of the remote server.
 
-= Contact Ohloh
+# Contact Ohloh
 
 For more information visit the Ohloh website:
-   http://labs.ohloh.net
+[Ohloh Labs](http://labs.ohloh.net)
 
 You can reach Ohloh via email at:
-   info@ohloh.net
+[info@ohloh.net](mailto:info@ohloh.net)