Changeset 4e2173e for doc


Ignore:
Timestamp:
Mar 24, 2017, 8:02:34 PM (3 years ago)
Author:
Paul Brossier <piem@piem.org>
Branches:
feature/autosink, feature/constantq, feature/pitchshift, feature/pydocstrings, feature/timestretch, master, sampler
Children:
e3c83bb
Parents:
5782f99
Message:

README.md: simplify, move detailed instructions to manual

Location:
doc
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • doc/building.rst

    r5782f99 r4e2173e  
    7474       $ waf configure build
    7575
     76
     77Running as a user
     78-----------------
     79
     80To use aubio without actually installing, for instance if you don't have root
     81access to install libaubio on your system,
     82
     83On Linux or macOS, sourcing the script ``scripts/setenv_local.sh`` should help::
     84
     85       $ source ./scripts/setenv_local.sh
     86
     87This script sets ``LD_LIBRARY_PATH``, for libaubio, and ``PYTHONPATH`` for the
     88python module.
     89
     90On Linux, you should be able to set ``LD_LIBRARY_PATH`` with::
     91
     92        $ export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$PWD/build/src
     93
     94On Mac OS X, a copy or a symlink can be made in ``~/lib``::
     95
     96        $ mkdir -p ~/lib
     97        $ ln -sf $PWD/build/src/libaubio*.dylib ~/lib/
     98
     99Note on Mac OS X systems older than El Capitan (10.11), the ``DYLD_LIBRARY_PATH``
     100variable can be set as follows::
     101
     102        $ export DYLD_LIBRARY_PATH=$DYLD_LIBRARY_PATH:$PWD/build/src
     103
    76104Cleaning
    77105--------
     
    95123.. _Git Bash: https://git-for-windows.github.io/
    96124
    97 .. toctree::
    98    :maxdepth: 2
     125.. _xcode-frameworks-label:
     126
     127.. include:: xcode_frameworks.rst
     128
     129.. include:: android.rst
  • doc/xcode_frameworks.rst

    r5782f99 r4e2173e  
    1 .. _xcode-frameworks-label:
    2 
    3 Using aubio frameworks in Xcode
    4 -------------------------------
     1Frameworks for Xcode
     2--------------------
    53
    64`Binary frameworks`_ are available and ready to use in your XCode project, for
     
    3634
    3735Using aubio from swift
    38 ......................
     36----------------------
     37
     38Once you have downloaded and installed :ref:`aubio.framework
     39<xcode-frameworks-label>`, you sould be able to use aubio from C, Obj-C, and
     40Swift source files.
     41
    3942
    4043Here is a short example showing how to read a sound file in swift:
Note: See TracChangeset for help on using the changeset viewer.