Makefile.inc: add getwaf / expandwaf rules

[vamp-aubio-plugins.git] / README.md

diff --git a/README.md b/README.md
index 39df76b..ddcc14e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -6,8 +6,6 @@ using the [aubio library](http://aubio.org/).
 
 This set includes the following plugins:
 
 
 This set includes the following plugins:
 

- - Spectral Descriptors
-

   - Aubio Beat Tracker
     - *Time → Tempo*
     - Estimate the musical tempo and track beat positions.
   - Aubio Beat Tracker
     - *Time → Tempo*
     - Estimate the musical tempo and track beat positions.


@@ -36,36 +34,42 @@ This set includes the following plugins:
 Build Instructions
 ------------------
 
 Build Instructions
 ------------------
 

-Please refer to the detailed instructions to build vamp-aubio-plugins for your
-platform in the following files:
+You will need to have Python, git, and a C++ compiler.
+
+Please refer to the build script corresponding for your platform for brief
+instructions on how to build this project:

 
 

-  - `INSTALL.osx` for Mac OS X
-  - `INSTALL.linux64` for Linux amd64
-  - `INSTALL.linux32` for Linux i686
-  - `INSTALL.mingw32` to cross-compile using [Mingw](http://www.mingw.org/)
+## Available OS scripts

 
 

-You can try running the corresponding file directly from the current directory.
-For instance, on a `Linux x86_64` host:
+  - `./build_linux.sh` for Linux
+  - `./build_osx.sh` for Mac OS X
+  - `./build_win32.sh` for Windows (32-bit)
+  - `./build_ming32.sh` to cross-compile using [Mingw](http://www.mingw.org/)

 
 

-    $ sh INSTALL.osx
+## Windows

 
 

-### Linux
+The preferred compiler on windows is Microsoft Visual 2013. Also you will want
+to use a shell environment, for instance Git Bash, and have Python installed
+and found in the PATH.

 
 

-Use Makefile.linux to compile vamp-aubio-plugins:
+### Clean up

 
 

-    $ make -f Makefile.linux clean all
+Use the following command to start from scratch:

 
 

-### Mac OS X
+    $ rm -rf contrib/ build/

 
 

-Use Makefile.osx to compile vamp-aubio-plugins:
+Old-school makefiles
+--------------------

 
 

-    $ make -f Makefile.linux clean all
+This method is now considered **deprecated**.

 
 

-### Windows
+The current build system is waf. See above, and read `wscript` and `build*.sh`
+to find out how to use it. Makefiles are kept for the record, but they might be
+out of date and will eventually disappear.

 
 

-Use Makefile.mingw32 to compile vamp-aubio-plugins:
+   $ make -f Makefile.<os_name> clean all

 
 

-    $ make -f Makefile.mingw32 clean all
+where `os_name` should be replaced by one of `linux`, `mingw32`, or `osx`.

 
 Installation Instructions
 -------------------------
 
 Installation Instructions
 -------------------------