# BUILDME file for KiNG

KiNG is built using Apache Ant, which stores its configuration in `build.xml`. Ant is the standard build tool for Java projects, like 'make' is for C/C++. It is written in Java and works cross-platform, anywhere that Java does. You can obtain Ant for free at http://ant.apache.org. These build files were written to work with Ant 1.6.1; if you have a newer version, there may have been some changes to the file structure.
To build the JAR and all the classfiles, rename the `king-xxxx-src`, `chiropraxis-xxxx-src`, and `driftwood-xxxx-src` directories to king, chiropraxis, and driftwood, respectively. Then enter the king directory and type ant dist. The necessary Driftwood and Chiropraxis libraries will be built automatically, followed by compilation of the KiNG code, followed by the creation of `king.jar` (which contains class files and resources from all three trees of code, as well as from the libraries included in the lib directory). The full KiNG distribution package ZIP files will be generated in king/dist. If you'd prefer to just compile the code and build the JAR files (and stop there), use the command ant build instead. The build.xml files also contain several other targets (deploy-xxx and backup, for instance) that are intended only for the use of the primary developer(s). Feel free to modify these so they do something useful on your machine.
KiNG uses some other open-source libraries, which are included in the lib directory for your convenience. Note that their licensing terms may differ substantially from KiNG's; see those distributions for details. If you would like to obtain updated versions of these libraries or simply get more information about them, you can visit their websites. The GNU regular expressions package gnu.regexp is available from http://www.cacas.org/java/gnu/regexp/, and the iText PDF-creation library is available from http://www.lowagie.com/iText/.

Last updated 4 Mar 2004 by IWD for KiNG version 1.22