Changeset 6f6c336 for doc

Timestamp:

Mar 24, 2017, 8:35:19 PM (8 years ago)

Author:

Paul Brossier <piem@piem.org>

Branches:

feature/autosink, feature/cnn, feature/cnn_org, feature/constantq, feature/crepe, feature/crepe_org, feature/pitchshift, feature/pydocstrings, feature/timestretch, fix/ffmpeg5, master, sampler

Children:

e0e4871

Parents:

a7eca0d

Message:

doc/: add cheat sheet, clean up

Location:

doc

Files:

• binaries.rst (added)
• building.rst (modified) (2 diffs)
• download.rst (modified) (1 diff)
• installing.rst (modified) (1 diff)

doc/building.rst

@@ -21 +21 @@
 The **latest stable release** can be downloaded from https://aubio.org/download::
 
-        $ curl -O http://aubio.org/pub/aubio-0.4.3.tar.bz2
-        $ tar xf aubio-0.4.3.tar.bz2
-        $ cd aubio-0.4.3
+        $ curl -O http://aubio.org/pub/aubio-<version>.tar.bz2
+        $ tar xf aubio-<version>.tar.bz2
+        $ cd aubio-<version>/
 
 Git repository
@@ -31 +31 @@
 
         $ git clone git://git.aubio.org/git/aubio
-        $ cd aubio
+        $ cd aubio/
 
 The following command will fetch the correct `waf`_ version (not included in

doc/download.rst

@@ -8 +8 @@
 <https://aubio.org/download>`_ for more options.
 
-To use aubio in a macOS or iOS application, see :ref:`xcode-frameworks-label`.
-
 To use aubio in an android project, see :ref:`android`.
 
-.. toctree::
+To compile aubio from source, read :ref:`building`.
 
-  debian_packages
-  xcode_frameworks
-  android
+.. include:: binaries.rst
 
-To compile aubio from source, read :ref:`building`.
+.. include:: debian_packages.rst

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 <Git repository>`::
 
-.. 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
-   building
-   requirements
+
+- :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>`::
+
+    # from git
+    pip install https://git.aubio.org/aubio/aubio/
+    # mirror
+    pip install https://github.com/aubio/aubio/
+    # from latest release
+    pip install https://aubio.org/pub/aubio-0.4.4.tar.gz
+    # from pypi
+    pip install aubio
+    # from source directory
+    cd aubio
+    pip install -v .
+
+- :ref:`install python-aubio from a pre-compiled binary <python>`::
+
+      # conda [osx, linux, win]
+      conda install -c conda-forge aubio
+      # .deb (debian, ubuntu) linux
+      sudo apt-get install 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
+    dpkg -l libsamplerate-dev libsndfile-dev
+
+.. include:: download.rst
+
+.. include:: building.rst
+
+.. include:: requirements