changeset 238:3f1d970f7406 refactoring

More details in INSTALL.txt
author mas01cr
date Thu, 13 Dec 2007 09:58:44 +0000
parents b2b39d7ecdf8
children
files INSTALL.txt
diffstat 1 files changed, 32 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/INSTALL.txt	Wed Dec 12 16:47:19 2007 +0000
+++ b/INSTALL.txt	Thu Dec 13 09:58:44 2007 +0000
@@ -12,7 +12,13 @@
 help2man: a spartan manual page is automatically generated from the
           usage text using help2man.
 
-Use the following Makefiles to compile audioDB on your system:
+bash: audioDB's test suite depends on /bin/sh being bash, version 3.0
+      or greater.
+
+Compiling
+---------
+
+Use the following make commands to compile audioDB on your system:
 
 Linux:         make
 (Debian-derived systems, with the right versions of gengetopt, gsoap
@@ -25,3 +31,28 @@
   GSOAP_INCLUDE="-I /path/to/gsoap"
 (where the path in GSOAP_INCLUDE should name the directory in which
 stdsoap2.h resides)
+
+Testing
+-------
+
+audioDB comes with a suite of test scripts that verify that particular
+pieces of functionality are behaving acceptably.  They depend on
+/bin/sh being GNU bash, version 3 or greater.  The test suite can be
+run with the command "make test".
+
+When running on systems without sparse file support (notably those
+using the default filesystem in Mac OS X), running the test suite
+requires approximately 70GB of free hard disk space.  On other
+systems, disk usage from running the test suite is negligible.
+
+Installation
+------------
+
+The audioDB executable is command-line database client, SOAP server
+and SOAP client all in one: to install for system-wide use, simply
+copy it to a place in the system-wide path.
+
+The build process also generates a Web Service Description file,
+adb.wsdl; to publish a description of an audioDB web service, you will
+need to edit that file to point to the network address and port of
+your audioDB server before publishing it on an ordinary HTTP server.