Changeset 6f6c336


Ignore:
Timestamp:
Mar 24, 2017, 8:35:19 PM (3 years ago)
Author:
Paul Brossier <piem@piem.org>
Branches:
feature/autosink, feature/constantq, feature/pitchshift, feature/pydocstrings, feature/timestretch, master, sampler
Children:
e0e4871
Parents:
a7eca0d
Message:

doc/: add cheat sheet, clean up

Location:
doc
Files:
1 added
3 edited

Legend:

Unmodified
Added
Removed
  • doc/building.rst

    ra7eca0d r6f6c336  
    2121The **latest stable release** can be downloaded from https://aubio.org/download::
    2222
    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
     23        $ curl -O http://aubio.org/pub/aubio-<version>.tar.bz2
     24        $ tar xf aubio-<version>.tar.bz2
     25        $ cd aubio-<version>/
    2626
    2727Git repository
     
    3131
    3232        $ git clone git://git.aubio.org/git/aubio
    33         $ cd aubio
     33        $ cd aubio/
    3434
    3535The following command will fetch the correct `waf`_ version (not included in
  • doc/download.rst

    ra7eca0d r6f6c336  
    88<https://aubio.org/download>`_ for more options.
    99
    10 To use aubio in a macOS or iOS application, see :ref:`xcode-frameworks-label`.
    11 
    1210To use aubio in an android project, see :ref:`android`.
    1311
    14 .. toctree::
     12To compile aubio from source, read :ref:`building`.
    1513
    16   debian_packages
    17   xcode_frameworks
    18   android
     14.. include:: binaries.rst
    1915
    20 To compile aubio from source, read :ref:`building`.
     16.. include:: debian_packages.rst
  • doc/installing.rst

    ra7eca0d r6f6c336  
    55operating systems.
    66
    7 To download a pre-compiled version of the library, head to :ref:`download`.
     7Aubio is available as a C library and as a python module.
    88
    9 To install the python extension, head to :ref:`python`.
     9Cheat sheet
     10-----------
    1011
    11 To compile aubio form source, first check the :ref:`requirements`, then read
    12 :ref:`building`.
     12- :ref:`get aubio latest source code <Git repository>`::
    1313
    14 .. toctree::
    15    :maxdepth: 2
     14    # official repo
     15    git clone https://git.aubio.org/aubio/aubio
     16    # mirror
     17    git clone https://github.com/aubio/aubio
     18    # latest release
     19    wget https://aubio.org/pub/aubio-<version>.tar.gz
    1620
    17    download
    18    building
    19    requirements
     21
     22- :ref:`build aubio from source <building>`::
     23
     24    # 1. simple
     25    cd aubio
     26    make
     27
     28    # 2. step by step
     29    ./scripts/get_waf.sh
     30    ./waf configure
     31    ./waf build
     32    sudo ./waf install
     33
     34- :ref:`install python-aubio from source <python>`::
     35
     36    # from git
     37    pip install https://git.aubio.org/aubio/aubio/
     38    # mirror
     39    pip install https://github.com/aubio/aubio/
     40    # from latest release
     41    pip install https://aubio.org/pub/aubio-0.4.4.tar.gz
     42    # from pypi
     43    pip install aubio
     44    # from source directory
     45    cd aubio
     46    pip install -v .
     47
     48- :ref:`install python-aubio from a pre-compiled binary <python>`::
     49
     50      # conda [osx, linux, win]
     51      conda install -c conda-forge aubio
     52      # .deb (debian, ubuntu) linux
     53      sudo apt-get install python-aubio aubio-tools
     54      # brew (osx)
     55      brew install aubio --with-python
     56
     57- :ref:`get a pre-compiled version of libaubio <download>`::
     58
     59    # .deb (linux) WARNING: old version
     60    sudo apt-get install aubio-tools
     61
     62    # python module
     63    ./setup.py install
     64    # using pip
     65    pip install .
     66
     67- :ref:`check the list of optional dependencies <requirements>`::
     68
     69    # debian / ubuntu
     70    dpkg -l libavcodec-dev libavutil-dev libavformat-dev \
     71            libswresample-dev libavresample-dev
     72    dpkg -l libsamplerate-dev libsndfile-dev
     73
     74.. include:: download.rst
     75
     76.. include:: building.rst
     77
     78.. include:: requirements
Note: See TracChangeset for help on using the changeset viewer.