<?xml version="1.0"?>
<!-- $Author: hoschek3 $, $Revision: 1.3 $, $Date: 2004/02/26 01:11:41 $ -->
<document>
  <properties>
    <author email="whoschek.AT.lbl.DOT.gov">Wolfgang Hoschek</author>
    <title>Readme</title>
  </properties>
<body>

<!-- ##################################################################################### -->
<section name="Quick File Overview">
<pre class="source">
doc/readme.html               - this file
doc/changelog.html            - lists recent changes to the source code (release notes)
doc/license.html              - the license defining the terms of use of the software
</pre>

<p>
The project website is a copy of the <code> doc/ </code> directory.
</p>
</section>


<!-- ##################################################################################### -->
<section name="Directories necessary for users of a binary distribution">
<pre class="source">
doc/                          - guides, tutorials, FAQ, etc.
doc/api/                      - generated javadoc HTML documentation
lib/                          - jar files for client usage
</pre>

</section>


<!-- ##################################################################################### -->
<section name="Directories necessary for developers">
<pre class="source">
src/                          - java source code
xdocs/                        - HTML for website generation
build.xml                     - ant build file to build the entire thing from scratch.
                                The build file contains build instructions
build/classes/                - temporary dir for compilation upon build
</pre>
</section>


<!-- ##################################################################################### -->
<section name="Building from source">
Most users will not need to build from source as a binary distribution of all
libraries is included in the download.
If you are a developer, then see the
build, tarball, etc. instructions in the ant build file <code>build.xml</code>.  

<listing name="Build Requirements">
jdk-1.2 or higher ('java' must be in your PATH)
ant-1.5.3 or higher (http://jakarta.apache.org/ant)
</listing>
<p></p>


<listing name="Define the path to your java installation and ant software. For example">
UNIX bash-style: 
	export PATH=/usr/local/java2/jdk/jdk-1.4/bin:$PATH

	export PATH=/usr/local/java2/share/apache/ant/bin:$PATH
	export JAVA_HOME=/usr/local/java2/jdk/jdk-1.4    
		(ant works without this but reports a warning)
		
Windows:
	set PATH=e:\java\jdk\sun-1.4.2\bin;%PATH%

	set PATH=e:\java\share\apache\ant-1.5.4\bin;%PATH%
	set JAVA_HOME=e:\java\jdk\sun-1.4.2              
		(ant works without this but reports a warning)
</listing>
<p></p>


<listing name="To build everything from scratch">
cd /opt/colt
ant build
</listing>  
<p></p>


<listing name="To get more information on other targets">
ant help
</listing>

</section>


<!-- ##################################################################################### -->
<section name="Feedback">

Comments are always welcome at <code>whoschek@lbl.gov</code>.

</section>

</body>
</document>
