summaryrefslogtreecommitdiffstats
path: root/INSTALL
diff options
context:
space:
mode:
Diffstat (limited to 'INSTALL')
-rw-r--r--INSTALL35
1 files changed, 35 insertions, 0 deletions
diff --git a/INSTALL b/INSTALL
new file mode 100644
index 00000000..f6e4dd44
--- /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.
+