aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJamie Bullock <jamie@jamiebullock.com>2014-11-06 17:18:02 +0000
committerJamie Bullock <jamie@jamiebullock.com>2014-11-06 17:18:02 +0000
commitb46aca1241df7bf23bfce6c28b6db203525340ac (patch)
tree40182d3dfae2535a29a4735da72fceb7e3153755 /README.md
parent89890e226e5da72743f885cefb5273c51baf094e (diff)
downloadLibXtract-b46aca1241df7bf23bfce6c28b6db203525340ac.tar.gz
LibXtract-b46aca1241df7bf23bfce6c28b6db203525340ac.tar.bz2
LibXtract-b46aca1241df7bf23bfce6c28b6db203525340ac.zip
Initial simplified build system based on GNU Make
Diffstat (limited to 'README.md')
-rw-r--r--README.md92
1 files changed, 2 insertions, 90 deletions
diff --git a/README.md b/README.md
index 19be5ad..bdddb1f 100644
--- a/README.md
+++ b/README.md
@@ -18,98 +18,12 @@ The latest source code release for LibXtract can be downloaded from [https://git
## Dependencies
-To build the PD external, the PD header 'm_pd.h' is required, this can be found in the [Pure Data source code release](http://puredata.info/downloads/pure-data).
-
-If you are compiling LibXtract from a GIT clone, the **autotools** build system is required. This includes:
-
- automake >= 1.11
- autoconf >= 2.68
- libtool >= 2.4
+To build the SWIG bindings [SWIG]() is required. For the Python bindings, a Python install is required. For the Java bindings a Java install is required.
## Installation
-If you are installing from a GIT clone, first run:
-
- sh autogen.sh
-
-If autogen.sh was successful, or you downloaded the source release, type:
-
- ./configure --enable-pd_example
- make
- sudo make install
-
-There following configure flags are optional:
-
- --enable-pd_example (to build the PD example)
- --enable-simpletest (to build the simpletest example)
-
-If you wish to build a Universal binary on OS X, you may need to do something like this:
-
- CFLAGS="-isysroot /Developer/SDKs/MacOSX10.4u.sdk -Wl,-syslibroot,/Developer/SDKs/MacOSX10.4u.sdk -arch i386 -arch ppc" \./configure --isable-dependency-tracking --your-options
-
-## Building the MSP external
-
-Type:
-
- cd examples/MSP
- make
- sudo make install
-
-To build for a specific architecture:
-
- make intel
- or
- make ppc
-
-## Building the Python bindings
-
-To build the python bindings, add to your configure flags:
-
- --enable-swig --with-python
-
-This requres additional dependencies to be resolved:
-
- swig >= 1.3
- python (with development files) >= 2.5
-
-It might work with earlier versions of Python, but this has not been tested.
+Type `make install` to build and install to `/usr/local`. Type `make install PREFIX=/somewhere/else` to install to `/somewhere/else`,
-If you do not have the 'standard' version of Python on OS X, you might need to tell the configure script where the python library is e.g.:
-
- ./configure --your-flags LDFLAGS="-L/Library/Frameworks/Python.framework/Versions/2.5/lib/python2.5/config/"
-
-To find your Python library type:
-
- locate libpython
-
-NOTE: The python module will get installed under the main install prefix, so if your install prefix is set to /usr/local, then the python module will get installed to /usr/local/lib/python2.5/site-packages/libxtract/xtract. You may need to add this to your PYTHONPATH environment variable. For example in ~/.bash_profile add:
- export PYTHONPATH=/usr/local/lib/python2.7/site-packages
-
-
-## Building the Java bindings
-
-To build the java bindings, add to your configure flags:
-
- --enable-swig --with-java
-
-This requres additional dependencies to be resolved:
-
- swig >= 1.3
- java (with development files) >= 2.0
-
-It might work with other versions of Java, but this has not been tested.
-
-On OS X, you will probably need to set your CLASSPATH environment variable before running ./configure
-
- export CLASSPATH=/System/Library/Frameworks/JavaVM.framework/Classes/classes.jar
-
-On OS X, you also probably need to tell the configure script where to find your Java (JNI) headers.
-
- ./configure --flags CFLAGS="-I/System/Library/Frameworks/JavaVM.framework/Headers"
-
-To find out where your headers are:
-
- locate jni.h
## Documentation
@@ -123,8 +37,6 @@ The generated HTML documentation can then be viewed in a web browser by opening
-
-
## LicenseĀ 
Copyright (C) 2012 Jamie Bullock