
			 How to install USE
			 ==================
			
1. Requirements
---------------

USE is implemented in Java(tm). Therefore, it should run on any
platform on which a Java runtime system (e.g. the Sun JDK) is
available. So far this has been tested only on Unix-like platforms
(Solaris and Linux) but it seems to work also on Windows. If you're
trying to install USE on any other platform, you are on your own,
although this should not be too difficult.

To compile USE you will need Sun's Java Development Kit (JDK) version
1.2 or later (see http://java.sun.com).


2. Compilation
--------------

The distribution of USE comes with compiled sources. If you don't
want or need to recompile them, you can skip this step!

Otherwise, look at the file Makefile.inc and change settings to your
site. Run `make clean' followed by `make all' (you will probably need
GNU make). This will recompile the whole USE package.

Interaction with USE is done via a command line interface. This will
be much more comfortable if you have the GNU readline library
available on your system. USE provides an interface to the readline
library. For example, it allows bash or emacs-like editing of lines
and keeps a history file of recent input. Since the readline library
is platform dependent, the interface has to be compiled on your
system. Changes to the file src/org/tzi/use/util/input/Makefile
may be necessary for your environment. The native code has been tested
with gcc-2.95.2. If you don't have the readline library - don't
worry. USE will fall back to a simple input mechanism if it cannot
find or load the readline library at runtime.

You can optionally do some tests by running `make test'. This will run
various tests in some of the package directories and calls USE to
compile the specifications in the example and test directory. There
should be no error output.


3. Basic Installation
---------------------

There are no additional libraries required. You should only make sure
that the `java' program is in your program search path.


4. Running USE
--------------

The easiest way to start USE, is to use the shell script supplied with
this distribution (there is also an untested file use.bat for
Windows). To use this wrapper script, add the bin directory to your
PATH environment variable. Entering

	use -h

will give you a list of command line options. Also, look at the file
use.properties in the etc directory to see if you have to adapt some
settings to your environment. See the file README for a quick tour
that will help you getting started.
