
INSTALLATION INSTRUCTIONS
-------------------------

1) Prerequisites:

By default this package is designed to build out of the box on a GNU/Linux distribution using entirely Free Software Java tools.

To work out of the box, your GNU/Linux system will need to be configured to use the JPackage repository, as per their instructions at http://www.jpackage.org/.

To build, you will need the Apache Ant tool.  This can be installed from JPackage with a command like 'yum install ant'.

For other platforms, you can modify the included build.properties file to match your setup, then use Ant to build.

Since we will be creating RPM's, you will also need the appropriate RPM build tool.  This can be installed with a command like 'yum install rpm-build'.


2) Source Distribution:

If you obtained this document by downloading and unpacking a zip file, then you have this already.

Or you can checkout the project from CVS.


3) Dependencies:

You can examine the included .spec file for packages named on lines starting with 'Requires' and 'BuildRequires', you will need these installed.  Again, that can probably be done with a command like 'yum install <packagename>'.


4) Build:

You need to start in the source distribution directory.

To build RPM's, 'ant rpmbuild' will output RPM's to the target/rpmbuild/RPMS/ folder.

For other platforms, the default Ant task will output a jar file to the target/ folder, and documentation under target/docs/.


5) Install:

Locate the built RPM's under the target/rpmbuild/RPMS/ folder.  These can be distributed, or installed with a command like 'rpm -ivf <rpmfilename>.rpm'.  This will install any JAR files into /usr/share/java/, API docs in /usr/share/javadoc/, documentation in /usr/share/doc/, and scripts in /usr/bin/.
