Changeset 155cc10 for doc/installing.rst


Ignore:
Timestamp:
Mar 10, 2017, 2:26:32 PM (2 years ago)
Author:
Paul Brossier <piem@piem.org>
Branches:
feature/autosink, feature/constantq, feature/pitchshift, feature/pydocstrings, feature/timestretch, master, sampler
Children:
ee8a57c
Parents:
00d0275 (diff), 67b6618 (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.
Message:

Merge branch 'master' into awhitening

File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/installing.rst

    r00d0275 r155cc10  
    1 .. highlight:: bash
    2 
    31Installing aubio
    42================
    53
    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>`_.
     4aubio runs on Linux, Windows, macOS, iOS, Android, and probably a few others
     5operating systems.
    96
    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.
     7To download a pre-compiled version of the library, head to :ref:`download`.
    138
    14 Source code
    15 -----------
     9To install the python extension, head to :ref:`python`.
    1610
    17 Check out the `download page <http://aubio.org/download>`_ for more options:
    18 http://aubio.org/download.
     11To compile aubio form source, first check the :ref:`requirements`, then read
     12:ref:`building`.
    1913
    20 The latest stable release can be found at http://aubio.org/pub/::
     14.. toctree::
     15   :maxdepth: 2
    2116
    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
     17   download
     18   building
     19   requirements
Note: See TracChangeset for help on using the changeset viewer.