Colt Sea Firefish | Version 1.2.0 - Last published Sep 9, 2004

Software
Home Download Installation Readme Mailing List Changelog
Development
Dependencies Javadoc API License
Search

Quick File Overview

>     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

> The project website is a copy of the `doc/` directory.

Directories necessary for users of a binary distribution

>     doc/                          - guides, tutorials, FAQ, etc.
>     doc/api/                      - generated javadoc HTML documentation
>     lib/                          - jar files for client usage

Directories necessary for developers

>     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

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 `build.xml`.
> Build Requirements
> jdk-1.2 or higher ('java' must be in your PATH) ant-1.5.3 or higher (http://jakarta.apache.org/ant)

> 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)

> To build everything from scratch
> cd /opt/colt ant build

> To get more information on other targets
> ant help

Feedback

> Comments are always welcome at `whoschek@lbl.gov`.

| Copyright © 1999, CERN - European Organization for Nuclear Research |