path: root/lv2/lv2plug.in/ns/lv2core/INSTALL
diff options
authorDavid Robillard <d@drobilla.net>2012-02-08 04:56:24 +0000
committerDavid Robillard <d@drobilla.net>2012-02-08 04:56:24 +0000
commited78bbe5ba12be1f9bcc736f14c51da6b4f639f3 (patch)
tree653a2dfe33f3923da45a38fc04ed2106f93528f3 /lv2/lv2plug.in/ns/lv2core/INSTALL
parentb617875c6f3ad439d25ae166da79df839ebfdc71 (diff)
Rearrange tree so top level can be used as an include path for standard style LV2 includes.
Diffstat (limited to 'lv2/lv2plug.in/ns/lv2core/INSTALL')
1 files changed, 41 insertions, 0 deletions
diff --git a/lv2/lv2plug.in/ns/lv2core/INSTALL b/lv2/lv2plug.in/ns/lv2core/INSTALL
new file mode 100644
index 0000000..16b1427
--- /dev/null
+++ b/lv2/lv2plug.in/ns/lv2core/INSTALL
@@ -0,0 +1,41 @@
+This software requires only Python to build. The build system, based on waf,
+is included in this source distribution.
+This package contains everything necessary to compile against and/or use LV2
+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 lv2core.lv2
+bundle. This 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
+As with most build systems, building and installing a project with waf is done
+in three separate stages:
+ 1. ./waf configure [OPTIONS]
+ 2. ./waf build
+ 3. ./waf install
+The default command is build. For example:
+ ./waf configure --prefix=/some/where
+ ./waf -j2
+ sudo ./waf install
+The environment variable DESTDIR can be used to add a prefix to all install
+paths (useful for packaging), for example:
+ DESTDIR=./lv2core.pkg ./waf install
+Run './waf --help' for detailed option information.