doc/installing.rst

   1 .. highlight:: bash
   2
   3 Installing aubio
   4 ================
   5
   6 A number of distributions already include aubio. Check your favorite package
   7 management system, or have a look at the `download page
   8 <http://aubio.org/download>`_.
   9
  10 aubio uses `waf <https://waf.io/>`_ to configure, compile, and test the source.
  11 A copy of ``waf`` is included along aubio, so all you need is a ``terminal``
  12 and a recent ``python`` installed.
  13
  14 Source code
  15 -----------
  16
  17 Check out the `download page <http://aubio.org/download>`_ for more options:
  18 http://aubio.org/download.
  19
  20 The latest stable release can be found at http://aubio.org/pub/::
  21
  22         $ curl -O http://aubio.org/pub/aubio-0.4.1.tar.bz2
  23         $ tar xf aubio-0.4.1.tar.bz2
  24         $ cd aubio-0.4.1
  25
  26 The latest develop branch can be obtained with::
  27
  28         $ git clone git://git.aubio.org/git/aubio/ aubio-devel
  29         $ cd aubio-devel
  30         $ git fetch origin develop:develop
  31         $ git checkout develop
  32
  33 Compiling
  34 ---------
  35
  36 To compile the C library, examples programs, and tests, run::
  37
  38         $ ./waf configure
  39
  40 Check out the available options using ``./waf configure --help | less``. Once
  41 you are done with configuration, you can start building::
  42
  43         $ ./waf build
  44
  45 To install the freshly built C library and tools, simply run the following
  46 command::
  47
  48         $ sudo ./waf install
  49
  50 Cleaning
  51 --------
  52
  53 If you wish to uninstall the files installed by the ``install`` command, use
  54 ``uninstall``::
  55
  56         $ sudo ./waf uninstall
  57
  58 To clean the source directory, use the ``clean`` command::
  59
  60         $ ./waf clean
  61
  62 To also forget the options previously passed to the last ``./waf configure``
  63 invocation, use the ``distclean`` command::
  64
  65         $ ./waf distclean