source: doc/installing.rst @ 0f3ee60

feature/autosinkfeature/constantqfeature/pitchshiftfeature/pydocstringsfeature/timestretchpitchshiftsamplertimestretchyinfft+
Last change on this file since 0f3ee60 was 0f3ee60, checked in by Paul Brossier <piem@piem.org>, 4 years ago

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

  • Property mode set to 100644
File size: 2.1 KB
RevLine 
[34abeaf]1.. highlight:: bash
2
[0f3ee60]3Building aubio
4==============
[34abeaf]5
[0f3ee60]6.. note::
7    To download a prebuilt version of aubio, see :ref:`download`.
[34abeaf]8
[0f3ee60]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.
[34abeaf]12
[0f3ee60]13Latest release
14--------------
[34abeaf]15
[0f3ee60]16The **latest stable release** can be downloaded from https://aubio.org/download::
[34abeaf]17
[8c00e7b]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
[34abeaf]21
[0f3ee60]22Git repository
23--------------
24
25The **latest git branch** can be obtained with::
[34abeaf]26
[8c00e7b]27        $ git clone git://git.aubio.org/git/aubio
28        $ cd aubio
[34abeaf]29
[0f3ee60]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
45
[34abeaf]46Compiling
47---------
48
49To compile the C library, examples programs, and tests, run::
50
51        $ ./waf configure
52
[0f3ee60]53Check out the available options using ``./waf configure --help``. Once
[34abeaf]54you are done with configuration, you can start building::
55
56        $ ./waf build
57
58To install the freshly built C library and tools, simply run the following
59command::
60
61        $ sudo ./waf install
62
[0f3ee60]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
[34abeaf]71Cleaning
72--------
73
74If you wish to uninstall the files installed by the ``install`` command, use
75``uninstall``::
76
77        $ sudo ./waf uninstall
78
79To clean the source directory, use the ``clean`` command::
80
81        $ ./waf clean
82
83To also forget the options previously passed to the last ``./waf configure``
84invocation, use the ``distclean`` command::
85
86        $ ./waf distclean
[0f3ee60]87
88.. _waf: https://waf.io/
89
90.. _Git Bash: https://git-for-windows.github.io/
91
92.. toctree::
93   :maxdepth: 2
Note: See TracBrowser for help on using the repository browser.