------------------------------------------------------------------------
| B U I L D I N G  T U R B I N E - 3
|
| $Id: BUILDING.txt,v 1.1 2002/02/19 18:10:13 jvanzyl Exp $
------------------------------------------------------------------------

------------------------------------------------------------------------
Q U I C K  S T A R T
------------------------------------------------------------------------

Here are the instructions for the impatient :-)

1. Define ${lib.repo} in your ${user.home}/build.properties (or by
   passing -Dlib.repo=/your/lib.repo to Ant on the command line)
2. Create ${lib.repo} directory
3. ant update-jars
4. ant

------------------------------------------------------------------------


#1. Install Ant 1.3 or higher and place the $ANT_HOME/bin directory into
    your PATH.

#2. Create a build.properties file in the jakarta-turbine-3 directory to 
    define the locations of the required jar files. This should be done 
    by first defining a ${lib.repo} directory location and then placing 
    those .jar files into that directory. The list of jar files required 
    is listed below as well as in the default.properties. You do not need 
    to add entries to your build.properties if the ones in default.properties 
    are already matching.

    Our plan is that eventually, this will be used by a automated system 
    that will download the necessary .jar files for you. However, at this 
    time, it is still a manual process.

    Please note that Turbine 3 is still in alpha and therefore
    depends on the CVS versions of other projects. Below is a chart
    which details the locations of all the dependencies for Turbine. Each 
    of the individual projects may also have a lot of dependencies. Yes, 
    we know this is a royal pain in the ass to deal with. Patches and help 
    to improve this process is welcome.

#4. Type: 'ant jar' This will build a turbine.jar file. There is also an 
    'ant install-jar' target that will copy the turbine.jar file into your 
    ${lib.repo} directory so that other packages can depend on it as well.


JAR                     Version                           URL
---------------------------------------------------------------------------------------------------
velocity.jar            CVS   (jakarta-velocity)          http://jakarta.apache.org/site/cvsindex.html
log4j.jar               1.1   (or higher)                 http://jakarta.apache.org/log4j/
servlet.jar             2.1   (or higher)                 (your servlet container has a copy)
fulcrum.jar             CVS   (jakarta-turbine-fulcrum)   http://jakarta.apache.org/site/cvsindex.html
regexp.jar              CVS   (jakarta-regexp)            http://jakarta.apache.org/site/cvsindex.html
torque.jar              CVS   (jakarta-turbine-torque)    http://jakarta.apache.org/site/cvsindex.html
jaf.jar                 1.0.1 (or higher)                 http://java.sun.com/products/javabeans/glasgow/jaf.html
xerces.jar              1.3.0 (or higher)                 http://xml.apache.org/xerces-j/
commons-collections.jar CVS   (jakarta-commons)           http://jakarta.apache.org/site/cvsindex.html
commons-util.jar        CVS   (jakarta-commons-sandbox)   http://jakarta.apache.org/site/cvsindex.html

Not required for building:
---------------------------------------------------------------------------------------------------
junit.jar               3.7   (or higher)                 http://www.junit.org/