Add submodules

1 files changed, 34 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..cfc92c0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+Drobillad
+=========
+
+This is a meta-project for building all the audio projects at
+http://drobilla.net/ in one step.
+
+## Updating ##
+
+The commands
+
+    git pull
+    ./waf update
+
+will update this repository and all git submodules to the latest version.
+
+## Building ##
+
+Building the top-level or individual projects is done in the same way as any
+other waf project, see any INSTALL file of a sub-project for details.  Be
+careful about switching between building the top-level and independent modules,
+independently configured modules will not be aware of the other libraries in
+this repository and check the system for dependencies instead.  It is best to
+do only one or the other, and clean everything if you switch.
+
+## Running from the source directory ##
+
+The top-level waf script provides a `run` command to run programs from the
+build directory without requiring installation.  The `run` command requires a
+`--cmd` argument, and will set the necessary environment
+(e.g. `LD_LIBRARY_PATH`) for running programs from the build directory:
+
+    ./waf run --cmd="build/patchage/patchage"
+
+ -- David Robillard <d@drobilla.net>