j###t ########## #### ####
j###t ########## #### ####
j###T "###L J###"
######P' ########## #########
######k, ########## T######T
####^###L ####
#### q###L ########## .#####
#### \###L ########## #####
© 1996 by Paul Mclachlan
INSTALLATION
You will require:
- Java
- About 5 megabytes of free disk space
The installation procedure is relatively simple. Create a directory off your
home directory called 'proj'. Extract the archive into this directory. This
will create a directory called 'key'.
Add an entry in your CLASSPATH environment variable for $HOME/proj/key/classes.
Add an entry in your path for $HOME/proj/key/bin
Thats it! Type 'key' to start it up with the defaults.
DIRECTORIES
- The 'online' directory holds Key generated text files. (spod lists, etc)
This directory may be removed in the future.
- The 'config' directory holds Key generated configuration files,
such as the standard (non-owned) landscape, and group information.
- The 'players' directory holds cachedatom's for every registered player
- The 'src' directory contains the java source code to key
- The 'bin' directory is mainly a holdover from the original C++ key, but holds
a couple of useful script files that you might want to use
- The 'dev' directory holds files that useful information for future development
can be gleaned from.
- The 'extern' directory holds files that were not written for key explicitly,
but that are used.
- The 'doc' directory contains the documentation for key, and doc/src is
the javadoc documentation of the source code
- The 'classes' directory contains the runtime classes required to execute
key - set your classpath so that it points to here
- The 'obs' directory contains obsolete code. (That was obsoleted by a
design decision). There's a small chance that it may be useful in the
future, or as a reference.
KNOWN BUGS
- Sites don't seem to be always matching correctly
- Actions need to be made static, somehow
REMAINING