README.md: add installation instructions on macosx
authorPaul Brossier <piem@piem.org>
Sun, 25 Oct 2015 04:42:23 +0000 (05:42 +0100)
committerPaul Brossier <piem@piem.org>
Sun, 25 Oct 2015 04:42:23 +0000 (05:42 +0100)
README.md

index 9115a18..1ceb814 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,7 +2,26 @@ ofxAubio
 ========
 
 ofxAubio is an [openFrameworks](openframeworks.cc) [addon](www.ofxaddons.com)
-that adds [aubio](aubio.org)
+for [aubio](aubio.org).
+
+Install
+-------
+
+## MacOSX
+
+ 1. fetch ofxAubio and aubio.framework from inside your openframeworks root
+
+    $ cd /path/to/of_root/addons
+    $ git clone git://git.aubio.org/git/ofxAubio/
+    $ cd ofxAubio
+    $ ./scripts/fetch_aubio_framework.sh
+
+  2. open projectGenerator, select 'update project', then select:
+
+    /path/to/of_root/addons/ofxAubio/
+
+  3. open `example_aubioDemo.xcodeproject`, drag `aubio.framework` into to it,
+     placing it in 'frameworks / 3rd party frameworks'.
 
 Project Homepage
 ----------------