aboutsummaryrefslogtreecommitdiffstats
path: root/ns/lv2core/INSTALL
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2011-11-20 23:08:57 +0000
committerDavid Robillard <d@drobilla.net>2011-11-20 23:08:57 +0000
commit725d4a404b838da6b67d9da66228a1125bddef57 (patch)
treea1daab3d767c85b1b67ff3a9eb60d54721b2e5fc /ns/lv2core/INSTALL
parent5ae0165d6d0420e95e22c1451e319b9e83398c28 (diff)
downloadlv2-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 'ns/lv2core/INSTALL')
-rw-r--r--ns/lv2core/INSTALL40
1 files changed, 40 insertions, 0 deletions
diff --git a/ns/lv2core/INSTALL b/ns/lv2core/INSTALL
new file mode 100644
index 0000000..c9c49dc
--- /dev/null
+++ b/ns/lv2core/INSTALL
@@ -0,0 +1,40 @@
+This software requires only Python to build. The build system, based on waf,
+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, 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 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:
+
+Configure: ./waf configure [OPTIONS]
+ e.g.: ./waf configure --prefix=/some/where
+
+ The default prefix is /usr/local
+
+
+Build: ./waf [OPTIONS]
+ e.g.: ./waf
+
+
+Install: ./waf install [OPTIONS]
+ e.g.: ./waf install
+ e.g.: DESTDIR=/home/drobilla/packages ./waf install
+
+ The environment variable DESTDIR can be used to add any prefix to
+ the install paths (useful for packaging).
+
+
+Run './waf --help' for detailed option information.