Instructions for building the jOAI software v3.1.1.4 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. Obtain the two code directories joai-project and dlese-tools-project from SourceForge CVS. 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 module 2. dlese-tools-project - the Java libraries source code module 3. Tomcat version 5.5.x or 6.x (available at http://tomcat.apache.org/) 4. Ant (available at http://ant.apache.org/) 5. Java Platform, Standard Edition v5 or v6 Obtaining the source code modules: The required joai-project and dlese-tools-project code modules are available via anonymous CVS at http://sourceforge.net/scm/?type=cvs&group_id=198325 Checkout branch 'joai_v3_1_1_branch' of each module to get the latest development version. Checkout a specific tag (on both modules) for a release version, for example tag oai_v3_1_1_3 corresponds to jOAI version 3.1.1.3. 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).