Changeset 5069da3 for doc


Ignore:
Timestamp:
Aug 27, 2016, 12:23:52 AM (8 years ago)
Author:
Paul Brossier <piem@piem.org>
Branches:
feature/autosink, feature/cnn, feature/cnn_org, feature/constantq, feature/crepe, feature/crepe_org, feature/pitchshift, feature/pydocstrings, feature/timestretch, fix/ffmpeg5, master, pitchshift, sampler, timestretch, yinfft+
Children:
2f965e2
Parents:
88f7cf9
Message:

installing.rst: split and rewrite

Location:
doc
Files:
2 added
2 edited

Legend:

Unmodified
Added
Removed

  • doc/download.rst

    r88f7cf9 r5069da3  
    33Downloading aubio
    44=================
    5 
    6 aubio runs on Linux, Windows, macOS, iOS, Android, and most operating systems.
    75
    86A number of distributions already include aubio. Check your favorite package
    … …  
    1917  xcode_frameworks
    2018  android
     19
     20To compile aubio from source, read :ref:`building`.

  • doc/installing.rst

    r88f7cf9 r5069da3  
    1 .. highlight:: bash
     1Installing aubio
     2================
    23
    3 Building aubio
    4 ==============
     4aubio runs on Linux, Windows, macOS, iOS, Android, and probably quite a few
     5others operating systems.
    56
    6 .. note::
    7     To download a prebuilt version of aubio, see :ref:`download`.
     7To download a pre-compiled version of the library, head to :ref:`download`.
    88
    9 aubio uses `waf`_ to configure, compile, and test the source.
    10 A copy of waf is included in aubio tarball, so all you need is a terminal,
    11 a compiler, and a recent version of python installed.
     9To install the python extension, head to :ref:`python`.
    1210
    13 Latest release
    14 --------------
    15 
    16 The **latest stable release** can be downloaded from https://aubio.org/download::
    17 
    18         $ curl -O http://aubio.org/pub/aubio-0.4.3.tar.bz2
    19         $ tar xf aubio-0.4.3.tar.bz2
    20         $ cd aubio-0.4.3
    21 
    22 Git repository
    23 --------------
    24 
    25 The **latest git branch** can be obtained with::
    26 
    27         $ git clone git://git.aubio.org/git/aubio
    28         $ cd aubio
    29 
    30 The following command will fetch the correct `waf`_ version (not included in
    31 aubio's git)::
    32 
    33         $ ./scripts/get_waf.sh
    34 
    35 .. note::
    36 
    37   Windows users without `Git Bash`_ installed will want to use the following
    38   commands instead:
    39 
    40   .. code:: bash
    41 
    42         $ curl -fsS -o waf https://waf.io/waf-1.8.22
    43         $ curl -fsS -o waf.bat https://raw.githubusercontent.com/waf-project/waf/master/utils/waf.bat
    44 
    45 
    46 Compiling
    47 ---------
    48 
    49 To compile the C library, examples programs, and tests, run::
    50 
    51         $ ./waf configure
    52 
    53 Check out the available options using ``./waf configure --help``. Once
    54 you are done with configuration, you can start building::
    55 
    56         $ ./waf build
    57 
    58 To install the freshly built C library and tools, simply run the following
    59 command::
    60 
    61         $ sudo ./waf install
    62 
    63 .. note::
    64   Windows users should simply run ``waf``, without the leading ``./``. For
    65   instance:
    66 
    67   .. code:: bash
    68 
    69        $ waf configure build
    70 
    71 Cleaning
    72 --------
    73 
    74 If you wish to uninstall the files installed by the ``install`` command, use
    75 ``uninstall``::
    76 
    77         $ sudo ./waf uninstall
    78 
    79 To clean the source directory, use the ``clean`` command::
    80 
    81         $ ./waf clean
    82 
    83 To also forget the options previously passed to the last ``./waf configure``
    84 invocation, use the ``distclean`` command::
    85 
    86         $ ./waf distclean
    87 
    88 .. _waf: https://waf.io/
    89 
    90 .. _Git Bash: https://git-for-windows.github.io/
     11To compile aubio form source, first check the :ref:`requirements`, then read
     12:ref:`building`.
    9113
    9214.. toctree::
    9315   :maxdepth: 2
     16
     17   download
     18   requirements
     19   building
Note: See TracChangeset for help on using the changeset viewer.