diff options
Diffstat (limited to 'core.lv2')
| -rw-r--r-- | core.lv2/INSTALL | 17 | ||||
| -rw-r--r-- | core.lv2/README | 26 |
2 files changed, 23 insertions, 20 deletions
diff --git a/core.lv2/INSTALL b/core.lv2/INSTALL index 0bc7f27..c9c49dc 100644 --- a/core.lv2/INSTALL +++ b/core.lv2/INSTALL @@ -4,20 +4,15 @@ is included in this source distribution. = LV2Core = This package contains everything necessary to compile against and/or use LV2 -plugins and extensions: a header file, pkg-config file, LV2 bundle (with Turtle -files), and a utility program (lv2config). +plugins and extensions: a header file, pkg-config file, and LV2 bundle (with +Turtle files). The configure option --bundle-only can be used to install only the bundle. This -is useful for installing the bundle to a user-specific location (e.g. ~/.lv2). - -Any C header(s) are a part of the bundle. Packages must not separate the -header(s) into a separate package from the bundle, as this would break -lv2config. The utility lv2config builds standard LV2 style include directory -trees, and is necessary for compiling LV2 code. Programs can use pkg-config to -check for package 'lv2core' to ensure all this data (bundle, including any -contained header(s), and lv2config) is available on the system. Programs may -also simply check for the header "lv2/lv2plug.in/ns/lv2core/lv2.h". +is useful for installing the bundle to a project-specific or user-specific +location (e.g. ~/.lv2). +See README for details on how to correctly package LV2, and how to depend on +LV2 in other projects. = Generic Waf Instructions = diff --git a/core.lv2/README b/core.lv2/README index 4e570f7..845bf40 100644 --- a/core.lv2/README +++ b/core.lv2/README @@ -10,17 +10,25 @@ 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, pkg-config file, and lv2config (a header installation utility required -to compile against LV2 core and/or extensions). To compile against LV2, build -scripts can check for the pkg-config package "lv2core", or simply check for the -header "lv2/lv2plug.in/ns/lv2core/lv2.h". +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 +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". Note -that lv2config must be run after installation of any LV2 specifications, -including this one. +Distributions are encouraged to include it with package name "lv2core". -- David Robillard <d@drobilla.net> |