changeset 35:11c7347afc10

More README updates
author Chris Cannam
date Thu, 22 Nov 2012 17:06:10 +0000
parents e9517315d4e5
children 2b3daa1d23bd
files README.txt
diffstat 1 files changed, 16 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/README.txt	Thu Nov 22 17:01:04 2012 +0000
+++ b/README.txt	Thu Nov 22 17:06:10 2012 +0000
@@ -8,6 +8,13 @@
 jVamp is a JNI (Java Native Interface) library that permits Java
 applications to load and use Vamp audio analysis plugins.
 
+See http://vamp-plugins.org/ for more information about Vamp plugins
+and for plugin downloads.
+
+Note that jVamp is intended to be compatible with the Android NDK as
+well as desktop Java, though it hasn't been tested there (and existing
+binary distributions of plugins do not usually include ARM builds).
+
 Vamp plugins are native-code plugins typically written in C++. In
 order to load them into a Java application, you need a native wrapper
 library (that is, jVamp) and both the wrapper and the plugin need to
@@ -45,3 +52,12 @@
 
    0.002902494, 9.999092970: 142.07474 142.1 bpm
 
+
+Note that you need the native-code libvamp-jni.so in your Java load
+path in order to run a host using jVamp, and it must have been built
+for the proper platform. Bear this in mind when planning to distribute
+software using jVamp!
+
+
+Any questions? Contact me at cannam@all-day-breakfast.com.
+