diff README.md @ 132:4b65e92da473

Updated README to cater for release vs SVN
author Jamie Bullock <jamie@postlude.co.uk>
date Sun, 10 Jun 2012 12:11:15 +0100
parents b6bf86eafc97
children cd6b321218f2
line wrap: on
line diff
--- a/README.md	Thu May 31 19:48:50 2012 +0100
+++ b/README.md	Sun Jun 10 12:11:15 2012 +0100
@@ -10,18 +10,31 @@
 
 A complete list of features can be found by viewing the header files, or reading the doxygen documentation, available with this package.
 
+## Downloading
+
+The latest source code release for LibXtract can be downloaded from [https://github.com/jamiebullock/LibXtract/downloads](https://github.com/jamiebullock/LibXtract/downloads).
+
 ## Dependencies
 
-To compile LibXtract, the following software is also needed:
+To compile LibXtract from the source code release, the following optional software is also needed:
 
-    automake >= 1.6
     fftw3 (compiled with floating-point support)
 
-To build the PD external, the PD header 'm_pd.h' is required
+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 compile from SVN, the **autotools** build system is required. This includes:
+
+    automake >= 1.11
+    autoconf >= 2.68
+    libtool >= 2.4
 
 ## Installation
 
-Type:
+If you are installing from SVN first run:
+
+    sh autogen.sh
+
+If autogen.sh was successful, or you downloaded the source release, type:
 
     ./configure --enable-pd_example --enable-fft
     make
@@ -33,7 +46,7 @@
     --enable-fft (to enable functions that require fftw3)
     --enable-simpletest (to build the simpletest example)
 
-If you wish to build a Universal binary on OS X:
+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