
                                  A V A L O N

                               Build Instructions

METHOD 1: From a Distribution

If all you are interested in is the Avalon Framework jar file, then all you
need is to have Ant installed and type the following command line:

$> ant all

If you want to regenerate the documentation or build a "distribution" of
Avalon Framework, then I highly suggest you use CVS to get the contents
of the tools directory.  If you are a masochist, and are hell-bent on
doing it the hard way, then the rest of the instructions are here to
help you get your build environment set up.

The Avalon build script looks for all of it's tools in the tools directory.
In order for everything to work for you, please make ${tools.dir} point to
your ANT installation directory.  In order to rebuild the documentation,
you need to make sure you have the following libraries in the proper location:

In ${tools.dir}/lib, you want to make sure you have the following libraries:

JUnit 3.7 or newer,
BSF.jar,
rhino.jar (this is Mozilla.org's Javascript engine)
Xalan 2 or newer,
Xerces 1.4 or newer

Please note that the most recent Xalan 2 requires the "xml-apis.jar" from
XML-commons, although it is included with Xalan's installation.

In ${tools.dir}/ext, you want to make sure you have the following libraries
from the latest Cocoon distribution (which will give you all the jars you
need):

Avalon Excalibur 4.0 or newer,
Avalon Framework 4.0 or newer (if you simply build the library first, you
                               can use the one from this distribution),
Avalon Logkit 1.0 or newer,
Batik-libs.jar (needed to work with FOP),
Fop-0.20.2.jar or better,
Jimi-1.0.jar,
Resolver.jar

Lastly, copy the files in the "tools" directory (the stylesheets) to the
${tools.dir} root directory.

Once your build environment is set up, Ant should be able to find all the
jars and dependancies it needs.  At this point, you can type "ant docs"
and the new documentation should start building.

METHOD 2: From CVS

In order to build any of the Jakarta Avalon projects, you must check out the
"jakarta-avalon" CVS module from cvs.apache.org.  You can view the instructions
for setting up CVS at http://jakarta.apache.org/site/cvsindex.html on the web.
You must check out all the Avalon projects in the same base directory.

For Example:

/home/joecool/projects/jakarta-avalon
/home/joecool/projects/jakarta-avalon-cornerstone
/home/joecool/projects/jakarta-avalon-excalibur
/home/joecool/projects/jakarta-avalon-logkit
/home/joecool/projects/jakarta-avalon-phoenix

Depending on the project you want to compile, position yourself in the correct
root directory.  For instance, if you want to build the jakarta-avalon project,
you would go to the /home/joecool/projects/jakarta-avalon directory.

If you are in a UNIX environment (or you are using Cygwin tools) you may type
the following command at the prompt:

$./build.sh

If you are in a Windows environment you may type the following command at the
prompt:

>build

The ant task will take care of everything else for you.

If you run into problems, make sure the JAVA_HOME variable is set to the
base directory of the proper JDK 1.2 or better Java Developer's Kit.  Please
note that you must use the developer's kit instead of the runtime environment
in order to compile the the projects.

