Changeset 0f3ee60


Ignore:
Timestamp:
Aug 26, 2016, 3:33:25 PM (4 years ago)
Author:
Paul Brossier <piem@piem.org>
Branches:
feature/autosink, feature/constantq, feature/pitchshift, feature/pydocstrings, feature/timestretch, master, pitchshift, sampler, timestretch, yinfft+
Children:
e635771
Parents:
8c00e7b
Message:

doc/: add download.rst, update installing.rst

Location:
doc
Files:
1 added
2 edited

Legend:

Unmodified
Added
Removed
  • doc/index.rst

    r8c00e7b r0f3ee60  
    108108
    109109.. toctree::
    110    :maxdepth: 1
     110   :maxdepth: 2
    111111
     112   download
    112113   installing
    113114   python_module
  • doc/installing.rst

    r8c00e7b r0f3ee60  
    11.. highlight:: bash
    22
    3 Installing aubio
    4 ================
     3Building aubio
     4==============
    55
    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>`_.
     6.. note::
     7    To download a prebuilt version of aubio, see :ref:`download`.
    98
    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.
     9aubio uses `waf`_ to configure, compile, and test the source.
     10A copy of waf is included in aubio tarball, so all you need is a terminal,
     11a compiler, and a recent version of python installed.
    1312
    14 Source code
    15 -----------
     13Latest release
     14--------------
    1615
    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/::
     16The **latest stable release** can be downloaded from https://aubio.org/download::
    2117
    2218        $ curl -O http://aubio.org/pub/aubio-0.4.3.tar.bz2
     
    2420        $ cd aubio-0.4.3
    2521
    26 The latest develop branch can be obtained with::
     22Git repository
     23--------------
     24
     25The **latest git branch** can be obtained with::
    2726
    2827        $ git clone git://git.aubio.org/git/aubio
    2928        $ cd aubio
     29
     30The following command will fetch the correct `waf`_ version (not included in
     31aubio'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
    3045
    3146Compiling
     
    3651        $ ./waf configure
    3752
    38 Check out the available options using ``./waf configure --help | less``. Once
     53Check out the available options using ``./waf configure --help``. Once
    3954you are done with configuration, you can start building::
    4055
     
    4560
    4661        $ 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
    4770
    4871Cleaning
     
    6285
    6386        $ ./waf distclean
     87
     88.. _waf: https://waf.io/
     89
     90.. _Git Bash: https://git-for-windows.github.io/
     91
     92.. toctree::
     93   :maxdepth: 2
Note: See TracChangeset for help on using the changeset viewer.