comparison INSTALL.txt @ 239:2cc06e5b05a5

Merge refactoring branch.

Bug fixes:
* 64-bit powertable bug;
* -inf - -inf bug;
* use new times information;
* plus short track, O2_MAXFILES and structure padding ABI fixes (already
  backported)

Major code changes:
* split source into functional units, known as 'files';
* Reporter class for accumulating and reporting on query results;
* much OAOOization, mostly from above: net 800 LOC (25%) shorter.

            exactly) for command-line parsing.
 
 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
 and help2man installed)
 

   SOAPCPP2=/path/to/bin/soapcpp2 \
   GSOAP_CPP=/path/to/gsoap/stdsoap2.cpp \
   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.