Changeset 155cc10 for README.md


Ignore:
Timestamp:
Mar 10, 2017, 2:26:32 PM (2 years ago)
Author:
Paul Brossier <piem@piem.org>
Branches:
feature/autosink, feature/constantq, feature/pitchshift, feature/pydocstrings, feature/timestretch, master, sampler
Children:
ee8a57c
Parents:
00d0275 (diff), 67b6618 (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 awhitening

File:
1 edited

Legend:

Unmodified
Added
Removed
  • README.md

    r00d0275 r155cc10  
    3131
    3232A python module to access the library functions is also provided. Please see
    33 the file `python/README` for more information on how to use it.
     33the file [`python/README.md`](python/README.md) for more information on how to
     34use it.
    3435
    3536Examples tools
     
    7172  https://aubio.org/documentation
    7273
    73 Installation and Build Instructions
    74 -----------------------------------
     74Build Instructions
     75------------------
    7576
    7677A number of distributions already include aubio. Check your favorite package
     
    8283    ./waf configure
    8384    ./waf build
    84     sudo ./waf install
    8585
    8686If waf is not found in the directory, you can download and install it with:
     
    8888    make getwaf
    8989
    90 aubio compiles on Linux, Mac OS X, Cygwin, and iOS.
     90aubio compiles on Linux, Mac OS X, Windows, Cygwin, and iOS.
     91
     92Installation
     93------------
     94
     95To install aubio library and headers on your system, use:
     96
     97    sudo ./waf install
     98
     99To uninstall:
     100
     101    sudo ./waf uninstall
     102
     103If you don't have root access to install libaubio on your system, you can use
     104libaubio without installing libaubio either by setting `LD_LIBRARY_PATH`, or by
     105copying it to `~/lib`.
     106
     107On Linux, you should be able to set `LD_LIBRARY_PATH` with:
     108
     109    $ export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$PWD/build/src
     110
     111On Mac OS X, a copy or a symlink can be made in `~/lib`:
     112
     113    $ mkdir -p ~/lib
     114    $ ln -sf $PWD/build/src/libaubio*.dylib ~/lib/
     115
     116Note on Mac OS X systems older than El Capitan (10.11), the `DYLD_LIBRARY_PATH`
     117variable can be set as follows:
     118
     119    $ export DYLD_LIBRARY_PATH=$DYLD_LIBRARY_PATH:$PWD/build/src
    91120
    92121Credits and Publications
     
    134163
    135164To subscribe to the list, use the mailman form:
    136 http://lists.aubio.org/listinfo/aubio-user/
     165https://lists.aubio.org/listinfo/aubio-user/
    137166
    138167Alternatively, feel free to contact directly the author.
     
    142171---------------------------------
    143172
    144 Copyright (C) 2003-2013 Paul Brossier <piem@aubio.org>
     173Copyright (C) 2003-2016 Paul Brossier <piem@aubio.org>
    145174
    146175aubio is free software: you can redistribute it and/or modify it under the
Note: See TracChangeset for help on using the changeset viewer.