Changeset 4e2173e for README.md


Ignore:
Timestamp:
Mar 24, 2017, 8:02:34 PM (7 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:
e3c83bb
Parents:
5782f99
Message:

README.md: simplify, move detailed instructions to manual

File:
1 edited

Legend:

Unmodified
Added
Removed

  • README.md

    r5782f99 r4e2173e  
    6464------------------
    6565
    66 A number of distributions already include aubio. Check your favorite package
    67 management system, or have a look at the [download
    68 page](https://aubio.org/download).
    69 
    70 aubio uses [waf](https://waf.io/) to configure, compile, and test the source:
    71 
    72     ./waf configure
    73     ./waf build
    74 
    75 If waf is not found in the directory, you can download and install it with:
    76 
    77     make getwaf
    78 
    7966aubio compiles on Linux, Mac OS X, Windows, Cygwin, and iOS.
    8067
    81 Installation
    82 ------------
     68To compile aubio, you should be able to simply run:
    8369
    84 To install aubio library and headers on your system, use:
     70    make
    8571
    86     sudo ./waf install
     72To compile the python module:
    8773
    88 To uninstall:
     74    ./setup.py build
    8975
    90     sudo ./waf uninstall
    91 
    92 If you don't have root access to install libaubio on your system, you can use
    93 libaubio without installing libaubio either by setting `LD_LIBRARY_PATH`, or by
    94 copying it to `~/lib`.
    95 
    96 On Linux, you should be able to set `LD_LIBRARY_PATH` with:
    97 
    98     $ export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$PWD/build/src
    99 
    100 On Mac OS X, a copy or a symlink can be made in `~/lib`:
    101 
    102     $ mkdir -p ~/lib
    103     $ ln -sf $PWD/build/src/libaubio*.dylib ~/lib/
    104 
    105 Note on Mac OS X systems older than El Capitan (10.11), the `DYLD_LIBRARY_PATH`
    106 variable can be set as follows:
    107 
    108     $ export DYLD_LIBRARY_PATH=$DYLD_LIBRARY_PATH:$PWD/build/src
     76See also the [manual](https://aubio.org/manual/latest/) for more information
     77about [compiling](https://aubio.org/manual/latest/building.html) and
     78[installing](https://aubio.org/manual/latest/installing.html).
    10979
    11080Credits and Publications
Note: See TracChangeset for help on using the changeset viewer.