mas01cr@0: Dependencies
mas01cr@0: ------------
mas01cr@0: 
mas01cr@132: gsoap: audioDB uses libgsoap++ for SOAP Web Services support.  This
mas01cr@132:        can be installed on most linux distributions using the package
mas01cr@132:        manager; the binary distribution will suffice.  Other systems
mas01cr@132:        will need to install the library.
mas01cr@0: 
mas01cr@132: gengetopt: audioDB uses gengetopt (as of 2007-10-23, version 2.18
mas01cr@132:            exactly) for command-line parsing.
mas01cr@0: 
mas01cr@132: help2man: a spartan manual page is automatically generated from the
mas01cr@132:           usage text using help2man.
mas01cr@0: 
mas01cr@239: bash: audioDB's test suite depends on /bin/sh being bash, version 3.0
mas01cr@239:       or greater.
mas01cr@239: 
mas01cr@281: gsl: the GNU Scientific Library.
mas01cr@281: 
mas01cr@239: Compiling
mas01cr@239: ---------
mas01cr@239: 
mas01cr@239: Use the following make commands to compile audioDB on your system:
mas01cr@0: 
mas01cr@138: Linux:         make
mas01cr@138: (Debian-derived systems, with the right versions of gengetopt, gsoap
mas01cr@138: and help2man installed)
mas01cr@138: 
mas01cr@138: OS X or Win32: make \
mas01cr@138:   GENGETOPT=/path/to/bin/gengetopt \
mas01cr@138:   SOAPCPP2=/path/to/bin/soapcpp2 \
mas01cr@138:   GSOAP_CPP=/path/to/gsoap/stdsoap2.cpp \
mas01cr@281:   GSOAP_INCLUDE="-I /path/to/gsoap" \
map01bf@282:   GSL_INCLUDE'"-I /path/to/gsl/"
mas01cr@281:   LIBGSL="-L/path/to/libgsl/libraries -lgsl -lgslcblas"
mas01cr@138: (where the path in GSOAP_INCLUDE should name the directory in which
map01bf@282: stdsoap2.h resides and the path to GSL_INCLUDE should name the directory
map01bf@282: which gsl_rng.h resides.)
mas01cr@239: 
mas01cr@239: Testing
mas01cr@239: -------
mas01cr@239: 
mas01cr@239: audioDB comes with a suite of test scripts that verify that particular
mas01cr@239: pieces of functionality are behaving acceptably.  They depend on
mas01cr@239: /bin/sh being GNU bash, version 3 or greater.  The test suite can be
mas01cr@239: run with the command "make test".
mas01cr@239: 
mas01cr@239: When running on systems without sparse file support (notably those
mas01cr@239: using the default filesystem in Mac OS X), running the test suite
mas01cr@239: requires approximately 70GB of free hard disk space.  On other
mas01cr@239: systems, disk usage from running the test suite is negligible.
mas01cr@239: 
mas01cr@239: Installation
mas01cr@239: ------------
mas01cr@239: 
mas01cr@239: The audioDB executable is command-line database client, SOAP server
mas01cr@239: and SOAP client all in one: to install for system-wide use, simply
mas01cr@239: copy it to a place in the system-wide path.
mas01cr@239: 
mas01cr@239: The build process also generates a Web Service Description file,
mas01cr@239: adb.wsdl; to publish a description of an audioDB web service, you will
mas01cr@239: need to edit that file to point to the network address and port of
mas01cr@239: your audioDB server before publishing it on an ordinary HTTP server.