From: Paul Brossier <piem@piem.org>
Date: Sat, 9 Feb 2013 09:12:23 +0000 (-0500)
Subject: README.md: switched to markdown, improve markup
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=f719589b3867d2a167fead6e990de8a3edb9d1b3;p=aubio.git

README.md: switched to markdown, improve markup
---

diff --git a/interfaces/python/README.md b/interfaces/python/README.md
new file mode 100644
index 00000000..59430493
--- /dev/null
+++ b/interfaces/python/README.md
@@ -0,0 +1,40 @@
+Python aubio module
+===================
+
+This module wraps the aubio library for python using the numpy module.
+
+See the [Python/C API Reference
+Manual](http://docs.python.org/c-api/index.html) and the [Numpy/C API
+Reference](http://docs.scipy.org/doc/numpy/reference/c-api.html)
+
+Compiling python aubio on Mac OS X
+----------------------------------
+
+Note: the following URLs to download from are given as examples only, you
+should check the corresponding pages for newer versions
+
+Download and install python 2.7 from [python.org](http://www.python.org/)
+
+    $ curl -O http://www.python.org/ftp/python/2.7.3/python-2.7.3-macosx10.6.dmg
+    $ open python-2.7.3-macosx10.6.dmg
+    # follow the instructions
+
+Download and install [setuptools](http://pypi.python.org/pypi/setuptools)
+  
+    $ curl -O http://pypi.python.org/packages/2.7/s/setuptools/setuptools-0.6c11-py2.7.egg
+    $ ${SUDO} sh setuptools-0.6c9-py2.4.egg
+
+Download and install [pip](http://www.pip-installer.org/en/latest/installing.html)
+
+    $ curl -O https://raw.github.com/pypa/pip/master/contrib/get-pip.py
+    $ ${SUDO} python get-pip.py
+
+Dowload and install [Scipy superpack](http://fonnesbeck.github.com/ScipySuperpack/)
+
+    $ curl -O https://raw.github.com/fonnesbeck/ScipySuperpack/master/install_superpack.sh
+    $ sh install_superpack.sh
+
+You should now be able to build the new python module. make sure the
+variables are correct in the file `build_osx` before running it:
+
+    $ ./build_osx
diff --git a/interfaces/python/README.rst b/interfaces/python/README.rst
deleted file mode 100644
index ba516e3a..00000000
--- a/interfaces/python/README.rst
+++ /dev/null
@@ -1,55 +0,0 @@
-===================
-Python aubio module
-===================
-
-This module wraps the aubio library for python using the numpy module.
-
-http://docs.python.org/c-api/index.html
-
-http://docs.scipy.org/doc/numpy/reference/c-api.html
-
-Instructions to compile the python module on Mac OS X
------------------------------------------------------
-
-Note: the following URLs to download from are given as examples only, you
-should check the corresponding pages for newer versions
-
-# install python 2.7 from python.org
-
-  url: http://www.python.org/
-
-  $ curl -O http://www.python.org/ftp/python/2.7.3/python-2.7.3-macosx10.6.dmg
-
-  $ open python-2.7.3-macosx10.6.dmg
-
-  follow the instructions
-
-# install setuptools http://pypi.python.org/pypi/setuptools
-
-  url: http://pypi.python.org/pypi/setuptools#files
-
-  $ curl -O http://pypi.python.org/packages/2.7/s/setuptools/setuptools-0.6c11-py2.7.egg
-
-  $ [sudo] sh setuptools-0.6c9-py2.4.egg
-
-# install pip 
-
-  url: http://www.pip-installer.org/en/latest/installing.html
-
-  $ curl -O https://raw.github.com/pypa/pip/master/contrib/get-pip.py
-
-  $ [sudo] python get-pip.py
-
-# install Scipy superpack
-
-  url: http://www.scipy.org/Download and http://fonnesbeck.github.com/ScipySuperpack/
-
-  $ curl -O https://raw.github.com/fonnesbeck/ScipySuperpack/master/install_superpack.sh
-
-  $ sh install_superpack.sh
-
-# you should now be able to build the new python module
-
-  make sure the variables are correct in the file build_osx before running it:
-
-  $ ./build_osx