ref: 655150cee58444f28637e5c45b84e3b9f599ddec
parent: 65fc06ffc46d76633eb577a181a38fb9a4fa50f2
author: Paul Brossier <piem@piem.org>
date: Fri Jul 22 17:50:21 EDT 2016
README.md: link to python/README.md
--- a/MANIFEST.in
+++ b/MANIFEST.in
@@ -1,5 +1,5 @@
include AUTHORS COPYING README.md VERSION ChangeLog
-include python/README
+include python/README.md
include Makefile wscript */wscript_build
include waf
include aubio.pc.in
--- a/README.md
+++ b/README.md
@@ -30,7 +30,8 @@
-------------
A python module to access the library functions is also provided. Please see
-the file `python/README` for more information on how to use it.
+the file [`python/README.md`](python/README.md) for more information on how to
+use it.
Examples tools
--------------
--- a/python/README
+++ /dev/null
@@ -1,64 +1,0 @@
-Python aubio module
-===================
-
-This module wraps the aubio library for Python using the numpy module.
-
-Before compiling this module, you must have compiled libaubio.
-
-For more information about how this module works, please refer to 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
-----------------------
-
-After libaubio has been build successfully, and provided Python development
-headers and numpy can be found on your system, you should be able to build the
-aubio Python module:
-
- $ ./setup.py build
-
-To find out more about `setup.py` options:
-
- $ ./setup.py --help
-
-Installing
-----------
-
-To install the Python module:
-
- $ ./setup.py install
-
-Using the Python module
------------------------
-
-Once the aubio library and the Python module are installed, you will be able to
-import the aubio module:
-
- $ python
- [...]
- >>> import aubio
- >>>
-
-Alternatively, you may want to use the Python module without installing it by
-setting PYTHONPATH:
-
- $ export PYTHONPATH=$PYTHONPATH:$PWD/`ls -rtd build/lib.* | head -1`:$PWD/tests
-
-Testing the Python module
--------------------------
-
-Once both the C library and the Python module have been built correctly, and
-after you have installed them (or setting the environment variable correctly),
-you should be able to run the tests:
-
- $ ./tests/run_all_tests
-
-And to try out the demos:
-
- $ ./demos/demo_source.py /path/to/sound/sample.wav
-
-You need to install additional modules to run some of the demos. For
-instance, several demos use [matplotlib](http://matplotlib.org/) to draw plots.
-Some more demos use [PySoundCard](https://github.com/bastibe/PySoundCard) to
-play and record sounds.
--- /dev/null
+++ b/python/README.md
@@ -1,0 +1,64 @@
+Python aubio module
+===================
+
+This module wraps the aubio library for Python using the numpy module.
+
+Before compiling this module, you must have compiled libaubio.
+
+For more information about how this module works, please refer to 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
+----------------------
+
+After libaubio has been build successfully, and provided Python development
+headers and numpy can be found on your system, you should be able to build the
+aubio Python module:
+
+ $ ./setup.py build
+
+To find out more about `setup.py` options:
+
+ $ ./setup.py --help
+
+Installing
+----------
+
+To install the Python module:
+
+ $ ./setup.py install
+
+Using the Python module
+-----------------------
+
+Once the aubio library and the Python module are installed, you will be able to
+import the aubio module:
+
+ $ python
+ [...]
+ >>> import aubio
+ >>>
+
+Alternatively, you may want to use the Python module without installing it by
+setting PYTHONPATH:
+
+ $ export PYTHONPATH=$PYTHONPATH:$PWD/`ls -rtd build/lib.* | head -1`:$PWD/tests
+
+Testing the Python module
+-------------------------
+
+Once both the C library and the Python module have been built correctly, and
+after you have installed them (or setting the environment variable correctly),
+you should be able to run the tests:
+
+ $ ./tests/run_all_tests
+
+And to try out the demos:
+
+ $ ./demos/demo_source.py /path/to/sound/sample.wav
+
+You need to install additional modules to run some of the demos. For
+instance, several demos use [matplotlib](http://matplotlib.org/) to draw plots.
+Some more demos use [PySoundCard](https://github.com/bastibe/PySoundCard) to
+play and record sounds.