= Application Building =
''This page describes how to build single applications. For official release and nightly build information/procedures, see BuildProcess''

OpenSHA uses [http://ant.apache.org/ Apache Ant] to automate the build process.

All ant build scripts are located in the [source:trunk/ant ant] directory.

== Important Files ==

=== [source:trunk/ant/build.xml build.xml] ===
Common build functions, including project building (building the entire project in your working directory, not creating jars) are loacted in this file. This file is also used by other build files to avoid duplication.
=== [source:trunk/ant/CompleteJar.xml CompleteJar.xml] ===
Creates single jar distributions. For a complete distribution (including data files), use the "jar.full.dist" target. To simple create a jar with all Java classes, use the "jar.classes.only" target
=== [source:trunk/ant/AppBuilder.xml AppBuilder.xml] ===
This is the core app building file. This will build a jar for a single application. It should not be run directly, however. It should be run by a separate build file, with the following properties set:
 * app.short.name - '''(required)''' The "short" name for the application (should not contain spaces/special characters).
   * ''example:'' !HazardCurveLocal
 * app.main.class - '''(required)''' The Java main class for the application.
   * ''example:'' org.opensha.sha.gui.!HazardCurveLocalModeApplication
 * javac.includes - '''''(recommended)''''' The javac includes for the application. Multiple patterns/files can be comma separated. If omitted, all .java files will be compiled. See "includes" for the [http://ant.apache.org/manual/Tasks/javac.html Javac Ant Task] for more information.
   * ''example:'' org/opensha/sha/gui/!HazardCurveLocalModeApplication.java
   * ''example:'' org/opensha/sha/gui/!HazardCurveLocalModeApplication.java,org/opensha/imr/!**/*.java
 * javac.excludes - ''(optional)'' The javac excludes for the application. Multiple patterns/files can be comma separated. See "excludes" for the [http://ant.apache.org/manual/Tasks/javac.html Javac Ant Task] for more information.
   * ''example:'' org/opensha/sra/**'
 * resource.target - '''''(recommended)''''' The target from [source:trunk/ant/build.xml build.xml] that should be executed to copy resources for this application.
   * ''example:'' resource.hazard.apps
   * ''example:'' resource.hazard.apps.server
   * ''example:'' resource.misc.required
 * rmi.target - ''(optional)'' The target from [source:trunk/ant/build.xml build.xml] that should be executed to compile RMI classes. Only required for RMI (remote) applications.
   * ''example:'' rmi.hazard.curve