This is a short description how to build and use classes contained in
this repository. Find more details in docs/index.html (but some files
will only be created there after the first build is completed).

If you do not want to build it you can use the binary distribution
which is available from ftp://ftp.ebi.ac.uk/pub/software/unix/soaplab
(or check docs/DistributionSite.html).

HOW TO BUILD IT
---------------

Just type:
   ./build.sh
or, on Windows platform.
   build.bat

You *can* use 'build.sh' (or 'build.bat') script to compile everything
anytime, but you *must* use it the first time (because it gathers all
third-party libraries needed for compilation).  Otherwise you *may*
use 'build-dev.sh' (or 'build-dev.bat') which is slightly faster
because it does not attempt to fetch libraries.

Therefore, when re-building, you would normally type:
   ./build-dev.sh
or, on Windows platform.
   build-dev.bat

In order to find what tasks are available, type:

   ./build-dev.sh -projecthelp
or
   build-dev.bat -projecthelp

The available task can be specified on the command line of the
building scripts. For example:
   ./build-dev.sh all
Default task is 'compile'.

The building scripts can make use of the following environment
variables:

   JAVA_HOME
      Pointing to a directory with your Java JDK.
      If not set the script tries to find it anyway (but not for the
      Windows platform - I do not know how to do it there :-)).

It also uses file 'build.properties' (if such file exists either in
this directory or in your home directory) - where you can specify
your-site-specific properties. See comments there (if any).

Last note for developers:
   If you want to commit your changes back consider to copy file(s)
'.cvsignore.template' into '.cvsignore. This will save you from
warning messages about local files which you do not want to commit
(e.g. generated 'build' directory).

HOW TO USE IT
-------------

Invoke any of the available command-line client (use the one ending
with '.bat' for Windows OS):

   ./run/run-analysis -help
   ./run/run-list -help
   ...

--------------------------------------------------------------------
Comments to Martin Senger (senger@ebi.ac.uk).
$Id: README,v 1.1.1.1 2005/06/15 09:00:00 marsenger Exp $
--------------------------------------------------------------------