From ca5e0f8b290a6355874f8b9f7935eacf332e9a42 Mon Sep 17 00:00:00 2001
From: Michael Jones <m.pricejones@gmail.com>
Date: Mon, 21 Dec 2009 17:05:27 +0000
Subject: [PATCH] Changed to markdown README has githubs rst rendering is quite
 poor

---
 README.rst => README.md | 38 +++++++++++++-------------------------
 1 file changed, 13 insertions(+), 25 deletions(-)
 rename README.rst => README.md (88%)

diff --git a/README.rst b/README.md
similarity index 88%
rename from README.rst
rename to README.md
index d45b3b3..587ff60 100644
--- a/README.rst
+++ b/README.md
@@ -1,31 +1,26 @@
-Sphinx to GitHub
-================
+<!-- Using markdown because github's rst rendering is so poor -->
+
+# Sphinx to GitHub
 
-About
------
- 
 A Python script for preparing the html output of the Sphinx documentation
 system for github pages.
 
 It renames any top level folders which start with an underscore and edits any
 references to them within the html files.
 
-Why?
-~~~~
+### Why?
 
 GitHub processes the incoming html with Jekyll which believes top level folders
 starting with an underscore are special and does not let their content be accessible
 to the server. This is incompatible with Sphinx which uses underscores at the
 start of folder names for static content.
 
-Usage
------
+## Usage
 
 The ``sphinxtogithub.py`` script can be run on the command line or used as a
 Sphinx extension.
 
-Extension
-~~~~~~~~~
+### Extension
 
 Place the script on the ``PYTHONPATH`` and add ``sphinxtogithub`` to the
 extensions list in the ``conf.py`` file in your Sphinx project::
@@ -39,17 +34,14 @@ verbose output. They are ``True`` by default::
    sphinx_to_github = True
    sphinx_to_github_verbose = True
 
-Command Line
-~~~~~~~~~~~~
+### Command Line
 
 Run the script with the path to the ``html`` output directory as the first
 argument. There is a ``--verbose`` flag for basic output.
 
-Further Information
--------------------
+## Further Information
 
-Install from GitHub
-~~~~~~~~~~~~~~~~~~~
+### Install from GitHub
 
 It should be possible to install this tool directly from github using pip::
 
@@ -57,28 +49,24 @@ It should be possible to install this tool directly from github using pip::
 
 Thanks to `winhamwr's <http://github.com/winhamwr>`_ work.
 
-Requirements
-~~~~~~~~~~~~
+### Requirements
 
 The script uses ``/usr/bin/env`` and ``python``.
 
-Running Tests
-~~~~~~~~~~~~~
+### Running Tests
 
 Unit tests can be run using the setuptools ``test`` target. eg::
 
    $ python setup.py test
 
-Alternatives
-~~~~~~~~~~~~
+### Alternatives
 
 `dinoboff's <http://github.com/dinoboff>`_ project `github-tools
 <http://github.com/dinoboff/github-tools>`_ provides similar functionality
 combined with a much more comprehensive set of tools for helping you to manage
 Python based projects on github.
 
-Credits
--------
+## Credits
 
 Thank you to: