RIDGE EXTRA CLASSES v0.8.0

(home)

HOWTO: Use REC

Download a release from the release page
Unpack the tarball wherever you normally put your libraries. This folder is referred to as REC_HOME from hereon in
Read the license in REC_HOME/LICENSE
Browse the API documentation in REC_HOME/docs/api/index.html
Add the JAR in REC_HOME/lib/rec.jar to your classpath and then just compile and go!

Here's what the structure of the distribution looks like:


    [-] REC_HOME
     \-[-] docs
     |  \-[-] api
     |  |  \-[X] ...
     |  \-[X] howto.html
     |  \-[X] index.html
     \-[-] lib
     |  \-[X] rec.jar
     \-[X] LICENSE
     \-[X] README

HOWTO: Build REC

Use anonymous CVS access to get the development tree as detailed on the CVS page. The module name to use is "rec".

Ant is included in CVS, so you need not install it seperately or configure it for building REC. REC's build script is not guaranteed to work with a version of Ant other than the one that is included.

This is the output of "ant -projecthelp":


Buildfile: build.xml
Main targets:

 build    compiles the library classes
 clean    removes all generated files and folders
 dist     prepares the library for distribution
 install  installs the library on the local system
 publish  unloads the documentation on the web server
 test     runs a particular unit test
 testall  runs all unit tests

Subtargets:

 testbuild


BUILD SUCCESSFUL

Total time: 3 seconds

* To run a particular unit test, the name of the test must be specified on the command line, like this:


    $ ant test -Dtest=util.Arrayz

A prefix of "org.gjt.rec." and a suffix of "Test" is implied when finding the the full class name of the test, so the example above runs the unit test in the class: org.gjt.rec.util.ArrayzTest.

Here's what the structure of the development tree looks like:


    [-] REC_HOME
     \-[-] bin
     |  \-[-] lib
     |  |  \-[X] ant.jar        required by Ant
     |  |  \-[X] jaxp.jar       required by Ant
     |  |  \-[X] junit.jar      required for unit testing
     |  |  \-[X] optional.jar   optional tasks for Ant
     |  |  \-[X] parser.jar     required by Ant
     |  \-[X] ant               Ant launch script
     \-[-] doc
     |  \-[X] LICENSE           REC license (LGPL)
     |  \-[X] README            a quick overview of REC
     |  \-[X] howto.html        this file
     |  \-[X] index.html        root of all REC documentation
     |  \-[X] package-list      used by javadoc to link to platform classes
     \-[+] examplesrc           source code for examples that use REC
     \-[+] src                  REC source code
     \-[+] testsrc              source code for REC unit tests
     \-[X] build.xml            Ant build script
     \-[X] init                 Adds Ant to the PATH and points it at Java

HOWTO: Contribute to REC

No contribution is too small. If you've written a class that can be reused but doesn't fit into a library, add it. The time spent making it generic is wasted if you don't.

Javadoc comments that cover the intended behaviour of your methods are essential. They form the contracts to which the unit tests are written. If you can write the unit tests, so much the better.

My e-mail address is on my user page.

Rather kindly hosted by

$Revision: 1.3 $, $Date: 2002/04/09 22:06:34 $