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