aboutsummaryrefslogtreecommitdiffstats
path: root/plugins/eg01-amp.lv2/README.txt
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2013-12-25 17:59:16 +0000
committerDavid Robillard <d@drobilla.net>2013-12-25 17:59:16 +0000
commit8b1275387c758c1ee894647517e5fb30adaa3ea4 (patch)
tree8f498ea7f856c3acf20c30caeea89ba37036ceec /plugins/eg01-amp.lv2/README.txt
parent74c991974146ab389d66052de904a84b44adf3ad (diff)
downloadlv2-8b1275387c758c1ee894647517e5fb30adaa3ea4.tar.xz
Bookify examploscope documentation.
Fix book generator to include single-star C comments in code blocks.
Diffstat (limited to 'plugins/eg01-amp.lv2/README.txt')
-rw-r--r--plugins/eg01-amp.lv2/README.txt18
1 files changed, 8 insertions, 10 deletions
diff --git a/plugins/eg01-amp.lv2/README.txt b/plugins/eg01-amp.lv2/README.txt
index f024a4d..41683d3 100644
--- a/plugins/eg01-amp.lv2/README.txt
+++ b/plugins/eg01-amp.lv2/README.txt
@@ -2,20 +2,18 @@
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 a control port which contain a single `float`.
+and a control port which contains 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++.
Static data is described separately in the human and machine friendly 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.
+Generally, the goal is to keep code minimal,
+and describe as much as possible in the static 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.
- * The standard format allow the use of existing vocabularies to describe plugins and related information
- * The data inherently integrates with the web, databases, etc.
- * Labels and documentation are translatable, and available to hosts for display in user interfaces
+ * Hosts can discover and inspect plugins without loading or executing any plugin code.
+ * Plugin data can be used from a wide range of generic tools like scripting languages and command line utilities.
+ * The standard data model allows the use of existing vocabularies to describe plugins and related information.
+ * The language is extensible, so authors may describe any data without requiring changes to the LV2 specification.
+ * Labels and documentation are translatable, and available to hosts for display in user interfaces.