ref: 0f3ee60bc14b7be7d5e39cb3073034e562134531
parent: 8c00e7bf75891dc36179df2a44799ce3a60eb1dd
author: Paul Brossier <piem@piem.org>
date: Fri Aug 26 11:33:25 EDT 2016
doc/: add download.rst, update installing.rst
--- /dev/null
+++ b/doc/download.rst
@@ -1,0 +1,20 @@
+.. _download:
+
+Downloading aubio
+=================
+
+aubio runs on Linux, Windows, macOS, iOS, Android, and most operating systems.
+
+A number of distributions already include aubio. Check your favorite package
+management system, or have a look at the `aubio download page
+<http://aubio.org/download>`_ for more options.
+
+To use aubio in a macOS or iOS application, see :ref:`xcode-frameworks-label`.
+
+To use aubio in an android project, see :ref:`android`.
+
+.. toctree::
+
+ debian_packages
+ xcode_frameworks
+ android
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -107,7 +107,8 @@
--------
.. toctree::
- :maxdepth: 1
+ :maxdepth: 2
+ download
installing
python_module
--- a/doc/installing.rst
+++ b/doc/installing.rst
@@ -1,33 +1,48 @@
.. highlight:: bash
-Installing aubio
-================
+Building aubio
+==============
+
+.. note::
+ To download a prebuilt version of aubio, see :ref:`download`.
-A number of distributions already include aubio. Check your favorite package
-management system, or have a look at the `download page
-<http://aubio.org/download>`_.
+aubio uses `waf`_ to configure, compile, and test the source.
+A copy of waf is included in aubio tarball, so all you need is a terminal,
+a compiler, and a recent version of python installed.
-aubio uses `waf <https://waf.io/>`_ to configure, compile, and test the source.
-A copy of ``waf`` is included along aubio, so all you need is a ``terminal``
-and a recent ``python`` installed.
+Latest release
+--------------
-Source code
------------
+The **latest stable release** can be downloaded from https://aubio.org/download::
-Check out the `download page <http://aubio.org/download>`_ for more options:
-http://aubio.org/download.
-
-The latest stable release can be found at http://aubio.org/pub/::
-
$ curl -O http://aubio.org/pub/aubio-0.4.3.tar.bz2
$ tar xf aubio-0.4.3.tar.bz2
$ cd aubio-0.4.3
-The latest develop branch can be obtained with::
+Git repository
+--------------
+The **latest git branch** can be obtained with::
+
$ git clone git://git.aubio.org/git/aubio
$ cd aubio
+The following command will fetch the correct `waf`_ version (not included in
+aubio's git)::
+
+ $ ./scripts/get_waf.sh
+
+.. note::
+
+ Windows users without `Git Bash`_ installed will want to use the following
+ commands instead:
+
+ .. code:: bash
+
+ $ curl -fsS -o waf https://waf.io/waf-1.8.22
+ $ curl -fsS -o waf.bat https://raw.githubusercontent.com/waf-project/waf/master/utils/waf.bat
+
+
Compiling
---------
@@ -35,7 +50,7 @@
$ ./waf configure
-Check out the available options using ``./waf configure --help | less``. Once
+Check out the available options using ``./waf configure --help``. Once
you are done with configuration, you can start building::
$ ./waf build
@@ -45,6 +60,14 @@
$ sudo ./waf install
+.. note::
+ Windows users should simply run ``waf``, without the leading ``./``. For
+ instance:
+
+ .. code:: bash
+
+ $ waf configure build
+
Cleaning
--------
@@ -61,3 +84,10 @@
invocation, use the ``distclean`` command::
$ ./waf distclean
+
+.. _waf: https://waf.io/
+
+.. _Git Bash: https://git-for-windows.github.io/
+
+.. toctree::
+ :maxdepth: 2