Kent Modelling Framework
                  Installation Notes
                   5th December 2002

About KMF
---------
KMF is being developed to provide a set of tools to support model
driven software development. At the core of KMF is ToolGen, a tool
to generate modelling tools from the definition of modelling
languages expressed as metamodels. ToolGen is supported by
OCL4Java, a Java library which allows dynamic evaluation of OCL
constraints; and XMI, a library that implements the XMI standard.
Tools generated using ToolGen use OCL4Java to provide built in
support for checking well-formedness of models, amongst other
things; they use XMI to write and read models in XMI format. XMI
is also used by ToolGen to read in metamodels in standard UML 1.3.
XMI 1.0 format. As KMF develops, we will be making available
specific modelling tools built with the help of ToolGen.

Platform
--------
KMF has been developed using Java and requires Java 1.4 or higher.
All the libraries required by KMF 1.1 are included in the
distribution.

Installation procedure
----------------------
The installation procedure assumes that you have downloaded the
KMF package from http://www.cs.ukc.ac.uk/kmf. The package, a zip
file, contains all the binary code, some examples, a user guide,
and a .bat file (for Windows platforms). KMF was tested and
developed on Windows XP using the open source Eclipse Framework
(www.eclipse.org).

Unzip the package into the desired location <root>. After that you
can start using ToolGen. This can be done on Windows system by
launching "startToolGen.bat" from the "bin" directory. For other
systems, invoke java as usual, making sure that the following
libraries (from the lib directory) are included in the classpath:
    xercesImpl.jar
    xmlParserAPIs.jar
    XMI.jar
    UMLModel.jar
    OCL4Java.jar
    JavaClass.jar
    ToolGen.jar
The main class is:
    uk.ac.ukc.cs.kmf.toolgen.Main
For installations that have multiple Java runtime environments
installed, ensure that the Java 1.4 runtime is used.

Files
-----
<root>
    "SK-ToolGen licence.txt"
        contains the licence for the ToolGen package
    "SK-OCL4Java licence.txt"
        contains the licence for the OCL4Java jar
<root>/bin
    startToolGen.bat
        the bat file used to launch ToolGen on Windows machines
<root>/examples
<root>/lib
    "javaClass.jar"
        used by OCL4Java to generate Java bytecode
    "OCL4Java.jar"
        used to build and evaluate OCL expressions
    "ToolGen.jar"
        the main package
    "UMLModel.jar"
        a jar file that allows the internal representation of UML
        notions
    "xercesImpl.jar"
    "xmlParsersAPIs.jar"
        an XML parser
    "XMI.jar"
        a framework to read/write XMI files

Uninstalling procedure
----------------------
Deleting the <root> directory and its content will uninstall ToolGen.
You don't have to reboot the system.

Acknowledgements
----------------
KMF makes use of, and is distributed with, the following open
source software:

The JavaClass library (now BCEL), available from
http://page.inf.fu-berlin.de/~dahm/JavaClass/

The Xerces library, available from http://xml.apache.org/