TCGUI 0.9 Installation manual

The installation procedure is very simple and consists of few steps. For up-to-date information, please visit the homepage at http://tcgui.sourceforge.net/.

Requirements

JDK 1.4+, may be optained at http://java.sun.com/
JGraph v3 library, may be optained at http://www.jgraph.com/. Howewer, you do NOT need to install this if the included JGraph is used.

Unpacking the package

TCGUI is provided in the package named tcgui-<version>.tar.gz. On UNIX based systems, chdir to the directory you want to unpack the package to and type the command

tar -xvzf tcgui-<version>.tar.gz

On Windows, use for example WinZip (http://www.winzip.com/) to do the job.

Package contents

Executable `JAR`

This package includes a jar file with compiled classes and the required library included for easier use. The JGraph library, its documentation and source code may be obtained at http://www.jgraph.com/. The jar is called tcgui.jar and may be run directly by issuing command

java -jar tcgui.jar

from the directory where the tcgui.jar is located. However, it may be also run by the scripts discussed below.

Run scripts

tcgui.jar may be run using the script run.sh on UNICes or run.bat on Windows. The jar file is expected to be in the same directory as the script, but you may change this behaviour by modifying your script.

Running TCGUI not using the included JGraph library

If you have the JGraph3 library already installed or you want it to be shared, extract the package cz.cmc.tcgui from the jar archive to your favourite location (e.g. /usr/local/tcgui). The main class is cz.cmc.tcgui.TCGui, so it may be run by

java cz.cmc.tcgui.TCGui

Note that your classpath have to contain both the tcgui and JGraph class paths. The easiest way to ensure this is to pass the classpath by the parameter -classpath of the java interpreter. For example,


java -classpath /usr/lib/j2sdk/lib/jgraph.jar:/usr/local/jgraph \

 cz.cmc.tcgui.TCGui

It is a good idea to put this into a script for it. See the java interpreter documentation for more details.

Documentation

The documentation is located in the doc directory of the package. The generated API documentation is in doc/api.

Source code

TCGUI sources, resource files, xml data definition files and localization files are in the src subtree of the package.

All trademarks used are properties of the respective owners.
Written by Martin Cizek, last change January 5, 2004.