diff options
author | David Robillard <d@drobilla.net> | 2011-11-20 23:08:57 +0000 |
---|---|---|
committer | David Robillard <d@drobilla.net> | 2011-11-20 23:08:57 +0000 |
commit | 725d4a404b838da6b67d9da66228a1125bddef57 (patch) | |
tree | a1daab3d767c85b1b67ff3a9eb60d54721b2e5fc /core.lv2/README | |
parent | 5ae0165d6d0420e95e22c1451e319b9e83398c28 (diff) | |
download | lv2-725d4a404b838da6b67d9da66228a1125bddef57.tar.xz |
Lay out repository structure to match include and URI structure.
Treat lv2core like all the other specifications in gendoc.py.
Diffstat (limited to 'core.lv2/README')
-rw-r--r-- | core.lv2/README | 34 |
1 files changed, 0 insertions, 34 deletions
diff --git a/core.lv2/README b/core.lv2/README deleted file mode 100644 index 845bf40..0000000 --- a/core.lv2/README +++ /dev/null @@ -1,34 +0,0 @@ -LV2 ---- - -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 -"hosts"). - -This core specification is deliberately as short and simple as possible, but is -designed so that extensions can be defined to add more advanced features. - -More information about LV2 can be found at <http://lv2plug.in>. - -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 -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" - -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" - -Please package these components in a single package (e.g. 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". - - -- David Robillard <d@drobilla.net> |