changeset 81:fd3ac263f42b

Updated Max external README
author Adam Stark <adamstark.uk@gmail.com>
date Tue, 25 Nov 2014 22:56:56 +0000
parents d812bf72d928
children 2d8cf2878483 ce802aba0a6a
files README.md modules-and-plug-ins/max-external/README.md
diffstat 2 files changed, 41 insertions(+), 10 deletions(-) [+]
line wrap: on
line diff
--- a/README.md	Tue Nov 25 22:47:09 2014 +0000
+++ b/README.md	Tue Nov 25 22:56:56 2014 +0000
@@ -17,6 +17,7 @@
 
 * Real-Time Beat-Synchronous Analysis of Musical Audio, A. M. Stark, M. E. P. Davies and M. D. Plumbley. In Proceedings of the 12th International Conference on Digital Audio Effects (DAFx-09), Como, Italy, September 1-4, 2009.
 
+BTrack is made available under the GNU General Public License, version 3. Please see the included LICENSE.txt for more details.
 
 Versions
 --------
@@ -36,11 +37,6 @@
 
 
 
-License
--------
-
-BTrack is made available under the GNU General Public License, version 3. Please see the included LICENSE.txt for more details.
-
 Usage - C++
 -----------
 
@@ -101,6 +97,14 @@
 		// do something on the beat
 	}
 
+Requirements
+------------
+
+To compile BTrack, you will require the following libraries:
+
+* FFTW
+* libsamplerate
+
 
 License
 -------
--- a/modules-and-plug-ins/max-external/README.md	Tue Nov 25 22:47:09 2014 +0000
+++ b/modules-and-plug-ins/max-external/README.md	Tue Nov 25 22:56:56 2014 +0000
@@ -5,12 +5,39 @@
 Build Instructions
 ------------------
 
-1. Edit the file maxmspsdk.xcconfig, setting the path to the c74support folder in your version of the Max SDK:
+Edit the file maxmspsdk.xcconfig in this directory, setting the path to the c74support folder in your version of the Max SDK:
 
 
-	// ===========================================================================
-	// NOTE: SET PATH TO YOUR C74SUPPORT FOLDER IN YOUR MAX SDK HERE
-	
 	C74SUPPORT = $(SRCROOT)/../../../SDKs/MaxSDK-6.1.4/c74support/
 	
-	// ===========================================================================			
\ No newline at end of file
+	
+Also, to compile BTrack, you will require the following libraries:
+
+* FFTW
+* libsamplerate
+
+Documentation
+-------------
+
+Please see the following two files for examples of how to use BTrack in Max:
+
+* btrack~.maxhelp
+* Beat Tracking Example.maxpat
+
+License
+-------
+
+Copyright (c) 2014 Queen Mary University of London
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
\ No newline at end of file