Changeset f264b17 for README.md

Timestamp:

Jun 22, 2016, 1:00:10 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, pitchshift, sampler, timestretch, yinfft+

Children:

4b9443c4

Parents:

60fc05b (diff), 6769586 (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 notes

File:

• README.md (modified) (6 diffs)

README.md

@@ -69 +69 @@
 The latest version of the documentation can be found at:
 
-  http://aubio.org/documentation
+  https://aubio.org/documentation
 
-Installation and Build Instructions
------------------------------------
+Build Instructions
+------------------
 
 A number of distributions already include aubio. Check your favorite package
 management system, or have a look at the [download
-page](http://aubio.org/download).
+page](https://aubio.org/download).
 
 aubio uses [waf](https://waf.io/) to configure, compile, and test the source:
@@ -82 +82 @@
     ./waf configure
     ./waf build
-    sudo ./waf install
 
 If waf is not found in the directory, you can download and install it with:
@@ -89 +88 @@
 
 aubio compiles on Linux, Mac OS X, Cygwin, and iOS.
+
+Installation
+------------
+
+To install aubio library and headers on your system, use:
+
+    sudo ./waf install
+
+To uninstall:
+
+    sudo ./waf uninstall
+
+If you don't have root access to install libaubio on your system, you can use
+libaubio without installing libaubio either by setting `LD_LIBRARY_PATH`, or by
+copying it to `~/lib`.
+
+On Linux, you should be able to set `LD_LIBRARY_PATH` with:
+
+    $ export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$PWD/build/src
+
+On Mac OS X, a copy or a symlink can be made in `~/lib`:
+
+    $ mkdir -p ~/lib
+    $ ln -sf $PWD/build/src/libaubio*.dylib ~/lib/
+
+Note on Mac OS X systems older than El Capitan (10.11), the `DYLD_LIBRARY_PATH`
+variable can be set as follows:
+
+    $ export DYLD_LIBRARY_PATH=$DYLD_LIBRARY_PATH:$PWD/build/src
 
 Credits and Publications
@@ -108 +136 @@
 
   - Paul Brossier, _[Automatic annotation of musical audio for interactive
-    systems](http://aubio.org/phd)_, PhD thesis, Centre for Digital music,
+    systems](https://aubio.org/phd)_, PhD thesis, Centre for Digital music,
 Queen Mary University of London, London, UK, 2006.
 
@@ -115 +143 @@
 
   - P. M. Brossier and J. P. Bello and M. D. Plumbley, [Real-time temporal
-    segmentation of note objects in music signals](http://aubio.org/articles/brossier04fastnotes.pdf),
+    segmentation of note objects in music signals](https://aubio.org/articles/brossier04fastnotes.pdf),
 in _Proceedings of the International Computer Music Conference_, 2004, Miami,
 Florida, ICMA
 
   -  P. M. Brossier and J. P. Bello and M. D. Plumbley, [Fast labelling of note
-     objects in music signals] (http://aubio.org/articles/brossier04fastnotes.pdf),
+     objects in music signals] (https://aubio.org/articles/brossier04fastnotes.pdf),
 in _Proceedings of the International Symposium on Music Information Retrieval_,
 2004, Barcelona, Spain
@@ -128 +156 @@
 -----------------------------
 
-The home page of this project can be found at: http://aubio.org/
+The home page of this project can be found at: https://aubio.org/
 
 Questions, comments, suggestions, and contributions are welcome. Use the