comparison README @ 162:8c8854a78dcd

* Update README, .la files etc for 1.3

 
 
 About this SDK
 ==============
 
-This is version 1.2 of the Vamp plugin Software Development Kit.
+This is version 1.3 of the Vamp plugin Software Development Kit.
 Plugins and hosts built with this SDK are binary compatible with those
 built using version 1.0 of the SDK.
 
 This SDK contains the following:
 

 
 Plugins should subclass Vamp::Plugin and then use Vamp::PluginAdapter
 to expose the correct C API for the plugin.  Plugin authors should
 read vamp-sdk/PluginBase.h and Plugin.h for code documentation, and
 refer to the example plugin code in the examples directory.  Plugins
-should link with -lvampsdk.  [*NOTE: this has changed from vamp-sdk in
-previous versions, to avoid conflict with the use of hyphens for
-library versioning schemes on some platforms.]
+should link with -lvamp-sdk.
 
 Hosts may use the Vamp::PluginHostAdapter to convert the loaded
 plugin's C API back into a Vamp::Plugin object.  Host authors should
 refer to the example host code in the host directory.  Hosts should
-link with -lvamphostsdk.  [*NOTE: this has changed from vamp-hostsdk
-in previous versions, to avoid conflict with the use of hyphens for
-library versioning schemes on some platforms.]
+link with -lvamp-hostsdk.
 
  * vamp-sdk/hostext
 
 Additional C++ classes to make a host's life easier (introduced in
 versions 1.1 and 1.2 of the Vamp SDK).

 trees, which is why this information is not queried as part of the
 Vamp plugin's API itself.  The Vamp::HostExt::PluginLoader class also
 provides support for plugin category lookup using this scheme.
 
 
-Building and Installing the SDK and Examples
-============================================
-
-To build the SDK, the simple host, and the example plugins, edit the
+Compiling the SDK and Examples
+==============================
+
+This SDK is intended for use on Windows, OS/X, Linux, and other POSIX
+platforms.
+
+ * Windows
+
+A project file for Visual Studio is included (VampPluginSDK.vcproj).
+This builds the SDK library, but does not build the example plugins or
+command-line host.
+
+Alternatively, when using Visual Studio or another IDE to build a
+plugin or host using the SDK, you can simply add the .cpp files in the
+vamp-sdk and vamp-sdk/hostext directories to your existing project.
+
+If you are using a Cygwin or MinGW GNU toolchain, use the included
+Makefile (see Linux and other POSIX platforms below).
+
+ * OS/X
+
+Run "make -f Makefile.osx" to build the SDK, example plugins, and
+command-line host.
+
+Note that the host requires that you have libsndfile
+(http://www.mega-nerd.com/libsndfile/) installed.  To build only the
+SDK and examples, "make -f Makefile.osx sdk examples".
+
+If you are using an IDE, you may prefer to simply add the .cpp files
+in the vamp-sdk and vamp-sdk/hostext directories to your existing
+project.
+
+ * Linux and other POSIX platforms
+
+To build the SDK, example plugins, and command-line host, edit the
 Makefile to suit your platform according to the comments in it, then
 run "make".
 
-There is a ready-tweaked Makefile for use on OS/X; to use it, run
-"make -f Makefile.osx".
-
-To use an IDE to build a plugin or host using the Vamp SDK, simply add
-the .cpp files in the vamp-sdk directory to your project.
+Note that the host requires that you have libsndfile
+(http://www.mega-nerd.com/libsndfile/) installed.  To build only the
+SDK and examples, edit the Makefile then run "make sdk examples".
+
+
+Installing the Example Plugins
+==============================
 
 Installing the example plugins so that they can be found by other Vamp
 hosts depends on your platform:
 
  * Windows: copy the files