# HG changeset patch # User ulalume3@yahoo.com # Date 1336735345 -7200 # Node ID f6927689a3b2532e46c8daa7bd98a4a21daab2d8 # Parent c769ef87d1103948b80cfcb339cd7e9d28808c92 Renaming readme.txt to readme.md to render markdown correctly. diff -r c769ef87d110 -r f6927689a3b2 readme.md --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/readme.md Fri May 11 13:22:25 2012 +0200 @@ -0,0 +1,34 @@ +== Quick start == +* Install Python 2.7 +* Install setup tools : http://pypi.python.org/pypi/setuptools +* Install sphinx by running +{{{ +#!python +easy_install Sphinx +}}} +* Go into the documentation directory and run +{{{ +#!python +make html +}}} +to generate an html version of the documentation or +{{{ +#!python +make latexpdf +}}} +to generate a PDF document. + +== Resources == + +Sphinx main page: +http://sphinx.pocoo.org + +Tutorial: +http://sphinx.pocoo.org/tutorial.html + +Restructured text: +http://sphinx.pocoo.org/rest.html + +Customising sphinx tutorial: +http://matplotlib.sourceforge.net/sampledoc/ + diff -r c769ef87d110 -r f6927689a3b2 readme.txt --- a/readme.txt Fri May 11 13:20:29 2012 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,34 +0,0 @@ -== Quick start == -* Install Python 2.7 -* Install setup tools : http://pypi.python.org/pypi/setuptools -* Install sphinx by running -{{{ -#!python -easy_install Sphinx -}}} -* Go into the documentation directory and run -{{{ -#!python -make html -}}} -to generate an html version of the documentation or -{{{ -#!python -make latexpdf -}}} -to generate a PDF document. - -== Resources == - -Sphinx main page: -http://sphinx.pocoo.org - -Tutorial: -http://sphinx.pocoo.org/tutorial.html - -Restructured text: -http://sphinx.pocoo.org/rest.html - -Customising sphinx tutorial: -http://matplotlib.sourceforge.net/sampledoc/ -