Read Me

This README will help you to establish your local development environment and to compile the sources code on Unix and Unix-like systems.

System Requirements:
-------------------

The following requirements exist for building Tanit project:

- JDK 1.4


How to configure local environment:
----------------------------------

After importing the Tanit project source code into your machine, the next step is to configure your local environment. To do, please follow these instructions:

1) Make sure that JAVA_HOME is set
You can check if the JAVA_HOME is set or not by typing:
   echo $JAVA_HOME

If it is set, the JAVA_HOME will be displayed, otherwise it's not set. In this case and to set the JAVA_HOME environment variable, you have to:

 1. open the ~/.bashrc file

 2. set <JAVA_HOME>  environment variable to point your JDK installation directory.
    export JAVA_HOME = <JAVA_HOME>. For example, export JAVA_HOME=/home/usr/jdk1.4

 3. Add <JAVA_HOME>\bin to system PATH.     export PATH=<JAVA_HOME>/bin:$PATH. For example, export PATH=$JAVA_HOME/bin:$PATH

2) Set your working directory
   export WORKDIR=${HOME}/work for example

3) Set your classes root
   export CLASSROOT=${WORKDIR}/classes

4) Set your libraries path
   export EXTDIRS=${WORKDIR}/tanit/lib

5) Set your class path
   export CLASSPATH=.:${JAVA_HOME}/jre/lib/rt.jar:${CLASSROOT}


The ~/.bashrc file will look like this:
/*********************************************************/
unset JAVAC
export WORKDIR=${HOME}/work
export CLASSROOT=${WORKDIR}/classes
export EXTDIRS=${WORKDIR}/tanit/lib
export CLASSPATH=.:${JAVA_HOME}/jre/lib/rt.jar:${CLASSROOT}
/*********************************************************/

Releasing a build:
-----------------

Now you can build the Tanit package by simply running the command:

  make

Under the project root directory.

Bugs Reporting:
--------------

If you find any bugs with the Tanit project please report it to tanit-develop@lists.sourceforge.net