]> * ===================================== * | Krysalis Centipede Build System | * ===================================== * by Nicola Ken Barozzi (nicolaken@apache.org) Marc Johnson (mjohnson@apache.org) started as an extension of the the Apache Cocoon Build System (http://xml.apache.org/cocoon/) by Stefano Mazzocchi (stefano@apache.org) Carsten Ziegeler (cziegeler@apache.org) Installing the build tools ========================== The Krysalis Centipede build system is based on Apache Ant, which is a Java building tool originally developed for the Tomcat project but now used in many other Apache projects and extended by many developers. Ant is a little but very handy tool that uses a build file written in XML (this file) as building instructions. For more information refer to "http://jakarta.apache.org/ant/". To make things easier for you, this distribution contains a precompiled version of Ant and the build scripts take care of running it. The only thing that you have to make sure, is the "JAVA_HOME" environment property should be set to match the JVM you want to use. That's all you have to do to be ready to go. Building instructions ===================== First, make sure your current working directory is where this very file is located. Then type ./build.sh (unix) .\build.bat (win32) if everything is right and all the required packages are visible, this action will start the build and prompt you with options. Note, that if you do further development, compilation time is reduced since Ant is able of detecting which files have changed and to recompile them at need. Also, you'll note that reusing a single JVM instance for each task, increases tremendously the performance of the whole build system, compared to other tools (i.e. make or shell scripts) where a new JVM is started for each task. Build targets ============= The build system is not only responsible of compiling the project into a jar file, but is also responsible for creating the HTML documentation, javadocs, distributions and web site. In fact, the file you have here is _exactly_ what is used by project maintainers to take care of everything in the project, no less and no more. To know more about the available targets take a look at this file, which is pretty self-explanatory, or run the build with "-projecthelp". Build Dependencies ================== Some components are optional and require special jar files to be compiled and added to the application. Some of these jars are already included in the distribution while others not. For each optional package which is not available, a warning can be printed. Happy hacking :) ============================================================================ &import-antipede;