From ada8b3c6abeaa2d08c3ed1c349bdade4843a028c Mon Sep 17 00:00:00 2001
From: Vincent Sanders <vince@kyllikki.org>
Date: Sun, 7 Dec 2014 12:41:05 +0000
Subject: Ensure all the library dependancies are listed

---
 README | 55 ++++++++++++++++++++++++++++++++++++-------------------
 1 file changed, 36 insertions(+), 19 deletions(-)

(limited to 'README')

diff --git a/README b/README
index 6baa85d..b416c8d 100644
--- a/README
+++ b/README
@@ -4,41 +4,58 @@ LibDOM -- an implementation of the W3C DOM
 Overview
 --------
 
-  LibDOM is an implementation of the W3C DOM API in C.
+LibDOM is an implementation of the W3C DOM API in C.
+
 
 Requirements
 ------------
 
-  libdom requires the following tools:
+The library uses the Netsurf core buildsystem which must be available
+(usually at the same level as the libsvg source)
+
+The PREFIX variable can be used to perform builds which do not install
+to global system paths.
+
+libdom requires the following tools:
 
-    + A C99 capable C compiler
-    + GNU make or compatible
-    + Perl (for the testcases)
+ - A C99 capable C compiler
+ - GNU make or compatible
+ - Perl (for the testcases)
 
-  LibDOM also requires the following libraries to be installed:
+LibDOM also requires the following libraries to be installed:
+
+ - LibParserUtils
+ - LibWapcaplet
+ - LibHubbub
 
-    +  LibParserUtils
-    +  LibWapcaplet
 
 Compilation
 -----------
 
-  If necessary, modify the toolchain settings in the Makefile.
-  Invoke make:
-  		$ make
+If necessary, modify the toolchain settings in the Makefile.
+
+Invoke make:
+
+  make
+
+The VARIANT variable allows builds for "release" (the default) and "debug"
+e.g.
+
+  make VARIANT=debug
+
 
 Verification
 ------------
 
-  To verify that the library is working, it is necessary to specify a 
-  different makefile target than that used for normal compilation, thus:
-  
-  		$ make test
+To verify that the library is working, it is necessary to specify a
+different makefile target than that used for normal compilation, thus:
+
+  make test
+
 
 API documentation
 -----------------
 
-  Currently, there is none. However, the code is well commented and the 
-  public API may be found in the "include" directory. The testcase sources 
-  may also be of use in working out how to use it.
-
+Currently, there is none. However, the code is well commented and the
+public API may be found in the "include" directory. The testcase
+sources may also be of use in working out how to use it.
-- 
cgit v1.2.3