Instructions for building the jOAI software v3.0.14 from source.

Quick instructions: 
--------------------------------------------

This software may be built easily using Ant. If you are already using Ant
and Tomcat, building the software is a three step process:
1. Unzip the jOAI software source files, which will contain the two directories
joai-project and dlese-tools-project.
2. Set the ant property 'catalina.home' to point to your Tomcat installation.
3. From the joai-project directory, execute the 'deploy' target.

This will build the software and place it in a directory named 'oai'
inside your Tomcat webapps directory.


Detailed instructions:
--------------------------------------------

To build the jOAI software from source you must have the following:
  
1. joai-project - the jOAI software source code directory
2. dlese-tools-project - the Java libraries source code directory
Note: 1 & 2 are available at http://www.dlese.org/dds/services/joai_software.jsp
by downloading the latest jOAI source distribution or via anonymous CVS at
http://sourceforge.net/cvs/?group_id=198325
3. Tomcat version 5.0.x or 5.5.x (available at http://tomcat.apache.org/)
4. Ant (available at http://ant.apache.org/)
5. Java Platform, Standard Edition v1.4 or later (1.5 or later recommended. Available from IBM at http://www-128.ibm.com/developerworks/java/jdk/
or from Sun at http://java.sun.com/javase/). Note that Java 2 comes pre-installed on 
Mac OS X (Jaguar or later).


Build instructions:

These instructions assume you will be working in a UNIX command-line environment.
The software can also be built on Windows but specific instructions are not 
provided here.

1. Obtain the joai-project and dlese-tools-project source directories (see above).

2. Obtain and install all the required tools (Java, Ant, Tomcat).

3. Place the joai-project and dlese-tools-project directories into a single directory.
For example:
 # cd ~/my_build_area
 # ls 
   dlese-tools-project joai-project
	  
4. cd into the joai-project directory.
  # cd joai-project

5. Create a file named build.properties in the joai-project directory 
(alternatively this can be placed in your home directory).

6. Edit the build.properties file and set the poperty catalina.home to
point to your intallation of Tomcat, for example:
catalina.home = /home/username/dev/apache-tomcat-5.5.12

See the build.xml file located in joai-project for information on the 
properties settings.

7. Execute the Ant deploy command.
  # ant deploy
You should see a number of messages in your terminal. Once complete
you should see a message like:
    BUILD SUCCESSFUL
    Total time: 36 seconds

8. The software will be built into a directory named oai inside your
Tomcat webapps directory. After (re)starting Tomcat you will be able to
access the software at the URL http://localhost:8080/oai/
(substitute localhost with your domain name if appropriate).


Additional support is available by e-mailing support@dlese.org.