path: root/lv2
diff options
authorDavid Robillard <d@drobilla.net>2011-11-21 02:58:41 +0000
committerDavid Robillard <d@drobilla.net>2011-11-21 02:58:41 +0000
commit9fe6329375ffce373129d3f545302c91aa82702c (patch)
treea5c01e653f9fbe66d524c97f7804ed70d206e4fa /lv2
parent763913f6eb08c4d2017e0e49189a929b63fcc5fe (diff)
Improve README.
Diffstat (limited to 'lv2')
1 files changed, 12 insertions, 4 deletions
diff --git a/lv2/ns/lv2core/README b/lv2/ns/lv2core/README
index 845bf40..f49513f 100644
--- a/lv2/ns/lv2core/README
+++ b/lv2/ns/lv2core/README
@@ -1,5 +1,5 @@
LV2 gives programmers the ability to write audio processors (or "plugins") in
C/C++ which can be dynamically loaded into a range of applications (or
@@ -10,6 +10,10 @@ designed so that extensions can be defined to add more advanced features.
More information about LV2 can be found at <http://lv2plug.in>.
+Using LV2
Applications that use LV2 plugins should depend on this package. It includes a
header, LV2 bundle, and a pkg-config file. To compile against LV2, build
scripts should check for the pkg-config package "lv2core", or simply check for
@@ -17,16 +21,20 @@ the header "lv2/lv2plug.in/ns/lv2core/lv2.h".
The appropriate C include for LV2 specifications is based on their URI, e.g.:
-#include "lv2/lv2plug.in/ns/lv2core/lv2.h"
+ #include "lv2/lv2plug.in/ns/lv2core/lv2.h"
Is how code should include the header "lv2.h" in this bundle, which defines the
specification with URI "http://lv2plug.in/ns/lv2core". Other specifications
should follow this convention, e.g. the correct way to include the header
"foo.h" in the extension "http://example.org/foo" is:
-#include "lv2/example.org/foo/foo.h"
+ #include "lv2/example.org/foo/foo.h"
-Please package these components in a single package (e.g. do not split the
+Please package these components in a single package (i.e. do not split the
headers, data, and program into separate packages). This package, in its
entirety, is a build and run time dependency of any code that uses LV2.
Distributions are encouraged to include it with package name "lv2core".