annotate README.txt @ 11:9d59073df981

Add licence
author Chris Cannam
date Fri, 10 May 2013 10:15:11 +0100
parents b2c6df0952eb
children c2369221825a
rev   line source
Chris@10 1
Chris@10 2 Vamp Test Plugin
Chris@10 3 ================
Chris@10 4
Chris@10 5 This is a test plugin for use by developers who are working on host
Chris@10 6 applications for Vamp plugins.
Chris@10 7
Chris@10 8 Its primary purpose is to help you test that your host is correctly
Chris@10 9 handling the output sample type and sample rate, as these are quite
Chris@10 10 easily misinterpreted. (See http://vamp-plugins.org/ for more about
Chris@10 11 Vamp plugins and http://vapm-plugins.org/guide.pdf for the programming
Chris@10 12 guide which explains the output sample type and sample rate.)
Chris@10 13
Chris@10 14 The plugin does no real work. It simply provides a variety of outputs
Chris@10 15 with different output descriptors, and returns some test values. See
Chris@10 16 https://code.soundsoftware.ac.uk/projects/vamp-test-plugin/wiki/Wiki
Chris@10 17 for documentation of the outputs and features returned.
Chris@10 18
Chris@10 19 If you are developing plugins rather than hosts, and you want help in
Chris@10 20 testing them, look instead at the Vamp Plugin Tester
Chris@10 21 (https://code.soundsoftware.ac.uk/projects/vamp-plugin-tester).