YALE 3.X INSTALLATION NOTES
---------------------------

This file describes the installation of YALE on your machine. You may
install YALE for all users of your system or for your own account 
locally.

Basically, there are two different ways of installing YALE:

* Installation of a Windows executable
* Installation of a Java version (any platform)

Both ways are described below. More information about the installation 
of YALE can be found at http://yale.sf.net/


Installation of the Windows executable
--------------------------------------

Just perform a double click on the downloaded file 
  
     yale-XXX-install.exe
     
and follow the installation instructions. As a result, there will be
a new menu entry in the Windows startmenu. YALE is started by clicking
this entry.


Installation of the Java version
--------------------------------

We assume that you have managed to unpack your downloaded archive,
because otherwise you would not be able to read these lines. 

The directory that was created contains the following files and
directories:

	scripts/*   Executable start scripts
	lib/		Java libraries and jar files
	lib/plugins	YALE plugins
	etc/		Configuration and template files
	sample/*	sample experiments
	sample/data	sample data
    src/        java sources (source version only)
	INSTALL.txt this file
	README.*	Readme files for used libraries
	LICENSE.txt	The GNU public license
	CHANGES.txt	Changes from previous versions

1. Make sure you have Java installed. YALE runs on Java 5.0 (aka 1.5)
   or higher. Type "java -version" on the command line to figure out 
   your Java version. A Java Runtime Environment can be downloaded 
   from http://java.sun.com/
   Make sure your JAVA_HOME environment variable is set to point to
   the correct location (i.e. the installation directory of Java).

2. You can start YALE using the executable jar file lib/yale.jar. On
   some operating systems, double clicking on lib/yale.jar starts 
   YALE.
   If that does not work, you can try typing something like
       java -jar lib/yale.jar
   If that does not work, you can use the start scripts in the 
   scripts directory. On a MS Windows system use bin\yale.bat 
   and bin\YaleGUI.bat, on a Unix system use bin/yale
   and bin/YaleGUI.

   (Optional) If you want to run YALE from anywhere on your system,
   add the bin directory to your path.

3. Test your installation. Use
 
   bin/yale EXPERIMENTFILE   to execute an experiment with the the
                             command line version. You can use one
			                 of the samples from the samples/ 
			                 directory.
   bin/YaleGUI               to start the graphical user interface 
                             of YALE (or make a double click on
                             lib/yale.jar if this works on your 
                             operating system).

4. If you have downloaded any of the additional YALE plugins, just
   copy the <plugin_name>.jar file to the directory lib/plugins.

5. If you downloaded the source version, you can compile the sources 
   using 'ant build' or 'ant dist'. Ant is a java build tool (like 
   'make') and can be downloaded from http://jakarta.apache.org/ant/
   YALE requires Ant version 1.6 or higher.


NOTE ON CONFIGURATION FILES:
----------------------------
YALE looks for the following configuration files and reads them in 
this ordering

  YALE_HOME/yalerc
  YALE_HOME/yalerc.OSNAME
  ~/.yale/yalerc
  ~/.yale/yalerc.OSNAME
  yalerc
  yalerc.OSNAME

Where OSNAME is the name of your operating system and ~ is your 
home directory. You can see which files are read when YALE starts.
