Changeset 633400d for doc/installing.rst

Timestamp:

Dec 5, 2018, 10:34:39 PM (5 years ago)

Author:

Paul Brossier <piem@piem.org>

Branches:

feature/cnn, feature/crepe, feature/pitchshift, feature/timestretch, fix/ffmpeg5, master

Children:

283a619a

Parents:

5b46bc3 (diff), f19db54 (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.

Message:

Merge branch 'master' into feature/pitchshift

File:

• doc/installing.rst (modified) (1 diff)

doc/installing.rst

@@ -5 +5 @@
 operating systems.
 
-To download a pre-compiled version of the library, head to :ref:`download`.
+Aubio is available as a C library and as a python module.
 
-To install the python extension, head to :ref:`python`.
+Cheat sheet
+-----------
 
-To compile aubio form source, first check the :ref:`requirements`, then read
-:ref:`building`.
+- :ref:`get aubio latest source code <building>`::
 
-.. toctree::
-   :maxdepth: 2
+    # official repo
+    git clone https://git.aubio.org/aubio/aubio
+    # mirror
+    git clone https://github.com/aubio/aubio
+    # latest release
+    wget https://aubio.org/pub/aubio-<version>.tar.gz
 
-   download
-   requirements
-   building
+
+- :ref:`build aubio from source <building>`::
+
+    # 1. simple
+    cd aubio
+    make
+
+    # 2. step by step
+    ./scripts/get_waf.sh
+    ./waf configure
+    ./waf build
+    sudo ./waf install
+
+- :ref:`install python-aubio from source <python-install>`::
+
+    # from git
+    pip install git+https://git.aubio.org/aubio/aubio/
+    # mirror
+    pip install git+https://github.com/aubio/aubio/
+    # from latest release
+    pip install https://aubio.org/pub/aubio-latest.tar.bz2
+    # from pypi
+    pip install aubio
+    # from source directory
+    cd aubio
+    pip install -v .
+
+- :ref:`install python-aubio from a pre-compiled binary <python-install>`::
+
+      # conda [osx, linux, win]
+      conda install -c conda-forge aubio
+      # .deb (debian, ubuntu) [linux]
+      sudo apt-get install python3-aubio python-aubio aubio-tools
+      # brew [osx]
+      brew install aubio --with-python
+
+- :ref:`get a pre-compiled version of libaubio <download>`::
+
+    # .deb (linux) WARNING: old version
+    sudo apt-get install aubio-tools
+
+    # python module
+    ./setup.py install
+    # using pip
+    pip install .
+
+- :ref:`check the list of optional dependencies <requirements>`::
+
+    # debian / ubuntu
+    dpkg -l libavcodec-dev libavutil-dev libavformat-dev \
+            libswresample-dev libavresample-dev \
+            libsamplerate-dev libsndfile-dev \
+            txt2man doxygen
+
+.. include:: download.rst
+
+.. include:: building.rst
+
+.. include:: requirements.rst