From b55df8b02dc38bd1cb9863f089b6a3f1f1773168 Mon Sep 17 00:00:00 2001
From: David Robillard <d@drobilla.net>
Date: Mon, 21 Nov 2011 04:13:20 +0000
Subject: Improve INSTALL file and use markdown syntax (why not).

---
 lv2/ns/lv2core/INSTALL | 37 +++++++++++++++++++------------------
 1 file changed, 19 insertions(+), 18 deletions(-)

(limited to 'lv2/ns')

diff --git a/lv2/ns/lv2core/INSTALL b/lv2/ns/lv2core/INSTALL
index c9c49dc..16b1427 100644
--- a/lv2/ns/lv2core/INSTALL
+++ b/lv2/ns/lv2core/INSTALL
@@ -1,40 +1,41 @@
 This software requires only Python to build. The build system, based on waf,
 is included in this source distribution.
 
-= LV2Core =
+
+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).
+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 =
+
+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
+ 1. ./waf configure [OPTIONS]
+ 2. ./waf build
+ 3. ./waf install
 
+The default command is build.  For example:
 
-Install: ./waf install [OPTIONS]
-   e.g.: ./waf install
-   e.g.:  DESTDIR=/home/drobilla/packages ./waf install
+    ./waf configure --prefix=/some/where
+    ./waf -j2
+    sudo ./waf install
 
-  The environment variable DESTDIR can be used to add any prefix to
-  the install paths (useful for packaging).
+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.
-- 
cgit v1.2.1