Mercurial > hg > vamp-aubio-plugins

changeset 163:f1cda26b578c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
README.md: update build instructions
author Paul Brossier <piem@piem.org>
date Sun, 24 Jul 2016 21:02:23 +0200
parents 5e944736a8ed
children 5dc3a9b2b0d9
files README.md
diffstat 1 files changed, 24 insertions(+), 18 deletions(-) [+]
line wrap: on
line diff
--- a/README.md	Sun Jul 24 21:02:05 2016 +0200
+++ b/README.md	Sun Jul 24 21:02:23 2016 +0200
@@ -36,36 +36,42 @@
 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.
 
-  - `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/)
+Please refer to the build script corresponding for your platform for brief
+instructions on how to build this project:
 
-You can try running the corresponding file directly from the current directory.
-For instance, on a `Linux x86_64` host:
+## Available OS scripts
 
-    $ sh INSTALL.osx
+  - `./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/)
 
-### Linux
+## Windows
 
-Use Makefile.linux to compile vamp-aubio-plugins:
+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.
 
-    $ make -f Makefile.linux clean all
+### Clean up
 
-### Mac OS X
+Use the following command to start from scratch:
 
-Use Makefile.osx to compile vamp-aubio-plugins:
+    $ rm -rf contrib/ build/
 
-    $ make -f Makefile.linux clean all
+Old-school makefiles
+--------------------
 
-### Windows
+This method is now considered **deprecated**.
 
-Use Makefile.mingw32 to compile vamp-aubio-plugins:
+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.
 
-    $ make -f Makefile.mingw32 clean all
+   $ make -f Makefile.<os_name> clean all
+
+where `os_name` should be replaced by one of `linux`, `mingw32`, or `osx`.
 
 Installation Instructions
 -------------------------