diff options
Diffstat (limited to 'plugins/eg-amp.lv2/README.txt')
| -rw-r--r-- | plugins/eg-amp.lv2/README.txt | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/plugins/eg-amp.lv2/README.txt b/plugins/eg-amp.lv2/README.txt new file mode 100644 index 0000000..c2ab37d --- /dev/null +++ b/plugins/eg-amp.lv2/README.txt @@ -0,0 +1,21 @@ +== Simple Amplifier == + +This plugin is a simple example of a basic LV2 plugin with no additional features. +It has audio ports which contain an array of `float`, +and control ports which contain a single `float`. + +LV2 plugins are defined in two parts: code and data. +The code is written in C (or any C compatible language, such as C++) and defines the executable portions of the plugin. +Static data is described separately in human and machine readable files in the http://www.w3.org/TeamSubmission/turtle/[Turtle] syntax. +Turtle is a syntax for the RDF data model, +but familiarity with RDF is not required to understand this documentation. + +Generally, code is kept minimal, +and all static information is described in the data. +There are several advantages to this approach: + + * Hosts can discover and inspect plugins without loading or executing any plugin code + * It is simple to work with plugin data using scripting languages, command line tools, etc. + * A standard format allows the re-use of existing vocabularies to describe plugins + * The data inherently integrates with the web, databases, etc. + * Labels and documentation are translatable, and available to hosts for display in user interfaces |