aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2011-05-26 01:45:08 +0000
committerDavid Robillard <d@drobilla.net>2011-05-26 01:45:08 +0000
commit2dc6c5d4541a015c9e9b91b1e471c4b1b55cf8a1 (patch)
treef2d1fdd8527c622a8bf5289999536c9669ab7921
parent3fd1ffebed5242a498a5849f9989055a0072c5bc (diff)
downloadlv2-2dc6c5d4541a015c9e9b91b1e471c4b1b55cf8a1.tar.xz
Add generic INSTALL file
-rw-r--r--INSTALL35
1 files changed, 35 insertions, 0 deletions
diff --git a/INSTALL b/INSTALL
new file mode 100644
index 0000000..f6e4dd4
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,35 @@
+This software requires only Python to build.
+
+Like an auto* project, building has three phases:
+
+
+* Configure: ./waf configure [OPTIONS]
+
+ Example:
+ ./waf configure --prefix=/some/where --debug --strict
+
+ If --debug is not given, the flags from the environment variables
+ CFLAGS and CXXFLAGS will be used.
+
+ The default prefix is /usr/local
+
+
+* Build: ./waf [OPTIONS]
+
+ Example:
+ ./waf -j4
+
+
+* Install: ./waf install [OPTIONS]
+
+ The environment variable DESTDIR can be used to add any prefix to
+ the install paths (useful for packaging). Example:
+
+ DESTDIR=/home/drobilla/packages ./waf install
+
+
+*** IMPORTANT: You must use absolute paths everywhere
+
+
+Run './waf --help' for detailed option information.
+