Installation Instructions
=========================


Requirements
------------
This package requires the following software:
1. A Java 5.0 compiler. You can obtain Sun's implementation of Java 5.0
   from http://java.sun.com/
2. Apache ant 1.6.5 or greater. You can obtain ant from 
   http://ant.apache.org
3. (Optional) If you wish to run the unit tests, you must have JUnit
   configured and installed. Visit http://www.junit.org to obtain
   JUnit.


Basic Install
------------
1. `cd' into the directory containing this file.
2. Run ant to compile and build the software. (If ant is in your path,
   simply type `ant'.)
3. A JAR file will be generated in the `image' directory. Place this
   JAR on the classpath of your application and start using the 
   Levenberg-Marquardt package.


Running the Unit Tests
------------
1. `cd' into the directory containing this file.
2. Type `ant unitTest' to compile and run the included unit tests.


Generating the JavaDocs
------------
1. `cd' into the directory containing this file.
2. Type `ant doc' to generate the JavaDocs. They will appear in the
   `docs' directory.


Full (public) Build File Target List
------------
image     Build the image jars (default)
compile   Compile the source
clean     Clear the image and build directories

unitTest  Run JUnit tests.

doc       Run the JavaDocs
cleanDoc  Remove the JavaDocs

