               Kent Modelling Framework
                  Installation Notes
                     Version 2.0

About KMF
---------
KMF is being developed to provide a set of tools to support model
driven software development. At the core of KMF is KMFStudio, a tool
to generate modelling tools from the definition of modelling
languages expressed as metamodels. KMFStudio is supported by
OCLCommon and OCL4KMF, two Java libraries which allows dynamic 
evaluation of OCL constraints. Tools generated using KMStudio use 
OCLCommon and OCL4KMF to provide built in support for checking 
well-formedness of models, amongst other things. YATL-Studio is 
a tool to transform source models into target models using 
transformations described in YATL. YATL-Studio uses the code 
generated by KMF-Studio. As KMF develops, we will be making available 
specific modelling tools built with the help of KMFStudio.

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

Installation procedure
----------------------
The installation procedure assumes that you have downloaded the
KMF tool 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 tools are tested and
developed on Windows XP using the Eclipse Framework from IBM.

Unzip the package into the desired location <root>. After that you
can start using the KMF tool. This can be done on Windows system by
launching "startKMFStudio.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
    CUPRuntime.jar
    UTIL-1.2.jar
    XMI-1.2.jar
    UMLModel-2.0.jar
    OCLCommon.jar
    OCL4KMF.jar
    KMFStudio-2.0.jar
The main class is:
    uk.ac.ukc.cs.kmf.kmfstudio.KMFStudio
For installations that have multiple Java runtime environments
installed, ensure that the Java 1.4 runtime is used.

Files
-----
<root>
    "KMFStudioLicense.txt"
        contains the licence for the KMFStudio
    "KMFLibraryLicense.txt"
        contains the licence for the libraries contained in the KMF distrubtion
<root>/bin
    startKMFStudio.bat
        the bat file used to launch KMFStudio on Windows machines
<root>/examples
<root>/lib
    "xercesImpl.jar"
    "xmlParsersAPIs.jar"
        an XML parser
    "CUPRuntime"
	a parser generator 
    "XMI-1.2.jar"
        a framework to read/write XMI files
    "UTIL-1.2.jar"
        a set of utilities
    "UMLModel-2.0"
        a jar file that allows the internal representation of UML
        notions
    "OCLCommon.jar" and "OCL4KMF.jar"
        used to build and evaluate OCL expressions
    "KMFStudio"
        the main package

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

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

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

The CUPRuntime library, available from http://www.cs.princeton.edu/~appel/modern/java/CUP/

Octavian Patrascoiu, University of Kent
15th March 2004
