ref: 4e2173e742478d46b11dbec9d2cdf30e505b5d5d
parent: 5782f99c808079d0530b9314312520c66f88a8f3
author: Paul Brossier <piem@piem.org>
date: Fri Mar 24 16:02:34 EDT 2017
README.md: simplify, move detailed instructions to manual
--- a/README.md
+++ b/README.md
@@ -63,49 +63,19 @@
Build Instructions
------------------
-A number of distributions already include aubio. Check your favorite package
-management system, or have a look at the [download
-page](https://aubio.org/download).
-
-aubio uses [waf](https://waf.io/) to configure, compile, and test the source:
-
- ./waf configure
- ./waf build
-
-If waf is not found in the directory, you can download and install it with:
-
- make getwaf
-
aubio compiles on Linux, Mac OS X, Windows, Cygwin, and iOS.
-Installation
-------------
+To compile aubio, you should be able to simply run:
-To install aubio library and headers on your system, use:
+ make
- sudo ./waf install
+To compile the python module:
-To uninstall:
+ ./setup.py build
- sudo ./waf uninstall
-
-If you don't have root access to install libaubio on your system, you can use
-libaubio without installing libaubio either by setting `LD_LIBRARY_PATH`, or by
-copying it to `~/lib`.
-
-On Linux, you should be able to set `LD_LIBRARY_PATH` with:
-
- $ export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$PWD/build/src
-
-On Mac OS X, a copy or a symlink can be made in `~/lib`:
-
- $ mkdir -p ~/lib
- $ ln -sf $PWD/build/src/libaubio*.dylib ~/lib/
-
-Note on Mac OS X systems older than El Capitan (10.11), the `DYLD_LIBRARY_PATH`
-variable can be set as follows:
-
- $ export DYLD_LIBRARY_PATH=$DYLD_LIBRARY_PATH:$PWD/build/src
+See also the [manual](https://aubio.org/manual/latest/) for more information
+about [compiling](https://aubio.org/manual/latest/building.html) and
+[installing](https://aubio.org/manual/latest/installing.html).
Credits and Publications
------------------------
--- a/doc/building.rst
+++ b/doc/building.rst
@@ -73,6 +73,34 @@
$ waf configure build
+
+Running as a user
+-----------------
+
+To use aubio without actually installing, for instance if you don't have root
+access to install libaubio on your system,
+
+On Linux or macOS, sourcing the script ``scripts/setenv_local.sh`` should help::
+
+ $ source ./scripts/setenv_local.sh
+
+This script sets ``LD_LIBRARY_PATH``, for libaubio, and ``PYTHONPATH`` for the
+python module.
+
+On Linux, you should be able to set ``LD_LIBRARY_PATH`` with::
+
+ $ export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$PWD/build/src
+
+On Mac OS X, a copy or a symlink can be made in ``~/lib``::
+
+ $ mkdir -p ~/lib
+ $ ln -sf $PWD/build/src/libaubio*.dylib ~/lib/
+
+Note on Mac OS X systems older than El Capitan (10.11), the ``DYLD_LIBRARY_PATH``
+variable can be set as follows::
+
+ $ export DYLD_LIBRARY_PATH=$DYLD_LIBRARY_PATH:$PWD/build/src
+
Cleaning
--------
@@ -94,5 +122,8 @@
.. _Git Bash: https://git-for-windows.github.io/
-.. toctree::
- :maxdepth: 2
+.. _xcode-frameworks-label:
+
+.. include:: xcode_frameworks.rst
+
+.. include:: android.rst
--- a/doc/xcode_frameworks.rst
+++ b/doc/xcode_frameworks.rst
@@ -1,8 +1,6 @@
-.. _xcode-frameworks-label:
+Frameworks for Xcode
+--------------------
-Using aubio frameworks in Xcode
--------------------------------
-
`Binary frameworks`_ are available and ready to use in your XCode project, for
`iOS`_ and `macOS`_.
@@ -35,7 +33,12 @@
import aubio
Using aubio from swift
-......................
+----------------------
+
+Once you have downloaded and installed :ref:`aubio.framework
+<xcode-frameworks-label>`, you sould be able to use aubio from C, Obj-C, and
+Swift source files.
+
Here is a short example showing how to read a sound file in swift: