ref: a9a1e79a8b4fa0fc1a1b51926650b197ad61ff4c
parent: e5234832e62731617b49339be4f091b025d83a74
author: Paul Brossier <piem@piem.org>
date: Fri Aug 26 21:40:48 EDT 2016
doc/requirements.txt: improve
--- a/doc/python_module.rst
+++ b/doc/python_module.rst
@@ -8,7 +8,7 @@
Installing aubio with pip
-------------------------
-aubio can now be installed using ``pip`` and ``easy_install``.
+aubio can now be installed using ``pip``:
.. code-block:: bash
--- a/doc/requirements.rst
+++ b/doc/requirements.rst
@@ -3,12 +3,18 @@
Requirements
============
-While aubio should build without any additional external libraries, we
-**strongly recommend** to build aubio with some additional dependancies.
+While aubio can be built without any external dependencies, we **recommend** to
+use at least some of the following libraries.
Platform notes
--------------
+On all platforms, you will need to have installed:
+
+ - a compiler (gcc, clang, msvc, ...)
+ - python (any version >= 2.7, including 3.x)
+ - a terminal to run command lines in
+
Linux
.....
@@ -74,8 +80,11 @@
Build options
-------------
-These options can be passed to configure
+Some additional options can be passed to the configure step. For the complete
+list of options, run:
+ $ ./waf configure --help
+
Double precision
................
@@ -132,7 +141,7 @@
``aubio_source``.
To enable this option, configure with ``--enable-sndfile``. The build will then
-failed if the required library is not found. To disable this option, configure
+fail if the required library is not found. To disable this option, configure
with ``--disable-sndfile``
libsamplerate
@@ -145,7 +154,7 @@
and ``aubio_resample`` will be fully functional.
To enable this option, configure with ``--enable-samplerate``. The build will
-then failed if the required library is not found. To disable this option,
+then fail if the required library is not found. To disable this option,
configure with ``--disable-samplerate``
libfftw3
@@ -159,7 +168,7 @@
that are not a power of 2.
To enable this option, configure with ``--enable-fftw3``. The build will
-then failed if the required library is not found. To disable this option,
+then fail if the required library is not found. To disable this option,
configure with ``--disable-fftw3``
External tools