* Outline of this README *
--------------------------
0. System Requirements
1. Installation instructions
2. Extended Installation instruction JAsCo on GNU/*/Linux
3. Testing instructions
4. Installation Layout
5. Troubleshooting

* 0. System Requirements *
--------------------------
- JDK 1.5!
- Windows 2000/XP, GNU/Linux or Mac OS X; any other os is not tested at this moment and parts of the program might fail.


* 1. Installation instructions *
--------------------------------

Installation Instructions:
# Unzip the jasco zip file to <installdir>
# Add <installdir>/bin to PATH environment variable *
# Add <installdir>/jasco.jar to CLASSPATH environment variable *
# Add <installdir>/jasco-libs.jar to CLASSPATH environment variable *
# Add <JAVA_HOME>/lib/tools.jar to CLASSPATH environment variable (only needed for hotswap 1, when you use JDK 1.5, this is not required)
# Run setup.bat or setup.sh in <installdir>
# JAsCo is configured.

Hint: make sure the java bin directory is in your PATH environment variable, so javac and java have to be executable from the prompt!
Hint2: Don't use spaces in directory names (e.g. not good: /var/test/my documents/JAsCo), JAsCo does not cope well with spaces.


* 2. Extended Installation instruction JAsCo on GNU/*/Linux *
-------------------------------------------------------------

* Unpacking the JAsCo package

Unpack JAsCo, e.g. in your home directory

$HOME/JAsCo


* JAsCo setup

The script setup.sh should be executed. In order to accomplish this
the file should have execute (x) permissions.

If the file setup.sh has no executable permissions, you can achieve
this by

chmod +x setup.sh

Running the setup :

./setup.sh


* PATH

The environment variable PATH must include <installdir>/bin . To set
your environment variables, please refer to the manual of the shell
you're using.

e.g. bash (GNU Bourne-Again SHell)

export PATH=$HOME/JAsCo/bin:$PATH


* CLASSPATH

The environment variable CLASSPATH must include :

<installdir>/jasco.jar
<installdir>/jasco-libs.jar
<JAVA_HOME>/lib/tools.jar (only required for deprecated hotswap 1 for JDK 1.4)

e.g. bash (GNU Bourne-Again SHell)

export CLASSPATH=$JAVA_HOME/lib/tools.jar:$HOME/JAsCo/jasco.jar:$HOME/JAsCo/jasco-libs.jar:$CLASSPATH


* Java 2 SDK

Of course, don't forget to put 

JAVA_HOME/bin in PATH

You should also add the current directory , '.' to your CLASSPATH


* 3. Testing instructions *
---------------------------

Use the scheme below to test the JAsCo Tool-suite (java 1.5 or higher):

    * Browse to the <installdir> where you installed the JAsCo Tool-suite and go to the examples/Tutorial1 folder
    * Compile the tracing.asp aspect by executing following command:
      CompileAspect tracing.asp 
    * Compile the TracingConnector.con connector by executing following command:
      CompileConnector TracingConnector.con 
    * Browse to the <installdir>/examples/Tutorial1/Generated and execute following command:
      java -javaagent:<installdir/jasco.jar> test.Main2
    * A visual application pops up and its execution is traced by the basic.asp aspect. 


Testing support for adaptive programming by traversal connectors :

    * Browse to the <installdir> where you installed the JAsCo Tool-suite and go to the examples/Tutorial2 folder
    * Compile the TestTraversal.trv traversal-connector by executing following command:
      CompileTraversal TestTraversal.trv
    * Browse to the <installdir>/examples/Tutorial2/Generated and execute following command:
      java test.trav.example.Example
    * The traversal as specified by the traversal connector TestTraversal.trv is invoked. 


* 4. Installation Layout *
--------------------------
/bin -> compilation scripts, generated by setup*
/classes -> optional, contains class files after compile
/doc -> JAsCo JavaDoc API
/examples -> several small examples
/icons -> contains icons for introspector tool
/src -> all JAsCo sources
/testing -> testing framework resources, contains a lot more JAsCo aspects/connectors

build.xml -> ant build file
COPYING -> license information
jasco-ant.jar -> ant tasks for JAsCo
jasco-distribution.jar -> required libraries for running JAsCo in distributed mode
jasco.jar -> Main JAsCo jar file (should always be on the classpath)
jasco-libs.jar -> JAsCo external libraries (should always be on the classpath)
setup.bat -> Windows Setup script that generates comilation scripts in ./bin
setup.sh -> *nix Setup script that generates comilation scripts in ./bin

* 5. Troubleshooting *
----------------------
Refer to the website: http://ssel.vub.ac.be/jasco or mail me: wvdperre@vub.ac.be

Don't forget to install the eclipse plugin for an easy to use JAsCo IDE!