Triveni: Installation and Usage Instructions

System Requirements

Triveni requires Java 2 Standard Edition (J2SE), preferably J2SE 1.3 or newer.

Triveni also requires also requires Apache Ant 1.5.2 or newer for building from source (optional).

Triveni also requires the following libraries and frameworks, which are already included in binary form in this distribution:

The Triveni team is grateful to the developers of these high-quality frameworks.

Installation

Unzip triveni-VERSION.zip or triveni-VERSION.tar.gz in a suitable directory. None of the directory names involved should contain spaces.

Usage

If you do not have Ant, please see below for instructions on running the demos using the included scripts. Otherwise you can run the demos from the top-level project directory like this:

    ant demo-counter1
    ant demo-counter1a
    ant demo-counter2
    ant demo-counter3
    ant demo-counter4
    ant demo-counter5
    ant demo-counter6
    ant demo-microwave
    ant demo-office
    ant demo-tester
    ant demo-battleship
    ant demo-choice
    ant demo-peer1
    ant demo-peer2

For complete documentation of the Triveni Java API and demos, please refer to the API documentation.

Triveni includes an XML-based front end. Please refer to Triveni XML reference, the Triveni XML examples, and the sources for the counter, microwave, and office demos. The triveni DOCTYPE is defined in triveni.dtd.

Building from Source (Optional)

To build the project:
```
    ant
```
To regenerate the javadoc:
```
    ant javadoc
```
To create a full distribution:
```
    ant dist
```
To clean the build tree:
```
    ant clean
```

Using Triveni in your own Projects

Libraries to include

You should include the following libraries in the project:

lib/triveni.jar
lib/concurrent.jar
lib/log4j.jar

Scripts for Running Demos and XML front end

Several scripts are provided for conveniently running the demos, as well as translating and compiling .tvn files.

Windows setup

Edit bin\setup.bat and change

    JAVA_HOME
    TRIVENI_HOME
    CODEBASE

to appropriate values for your system. Then run bin\setup.bat once in any new terminal window you open before running the scripts mentioned below.

Unix setup

If the environment variable JAVA_HOME is already set correctly on your system, then you need not modify bin/setup.sh. Otherwise edit bin/setup.sh to change JAVA_HOME to an appropriate value for your system. Now you can directly run the scripts mentioned below without first running bin/setup.sh.

Running the scripts

To run the demos:

    bin\run triveni.demo.counter.Demo1
    bin\run triveni.demo.microwave.Microwave
    bin\run triveni.demo.office.Office Moe Larry Curly
    etc.

To translate File.tvn to File.java:
```
    bin\translate File
```
To translate File.tvn to File.java and compile File.java:
```
    bin\compile File
```