CLaRK System - XML Based System for Corpora Development
                             version 3.0
====================================

Homepage: http://www.bultreebank.org/

System Requirement
------------------
* Java Development Kit (JDK) version 1.3 or higher
    available at http://java.sun.com/
* Zip archive extractor (WinZip, unzip, .... )

Installation
------------------
Important files and folders:
    clarkSystem.jar
        - the main engine of the CLaRK System.
    
    readme.txt
        - this file.

    errors.log
	- this is a LOG file containing system error data. If you like to submit
	a bug report, please send this file to the support team. It may help us
	to find the problem.
    
    documentation/
        - this is the documentation of the system. 
          This is a general description of the technology,
	tools and the ideas of the system.

    manual/
        - this is the user manual of the system.
          This is a detailed description of
          each tool and component.
    
    manual/index.htm
        - the starting document of the user manual

    manual/reference.htm
        - a quick reference for most frequently 
          used notions in the system.

    license/license.txt
        - a document with the license agreement for 
          using the CLaRK System

    ClarkSystem.bat (windows OS)
        - this is a file needed only for MS Windows usage. 
          If the file is missing it is not a problem. 
	Its content will be described below.
    
    ClarkSystem.uni (unix OS)
        - this is needed only for UNIX usage. 
          If the file is missing it is not a problem.
          Its content will be described below.

    resources/
        - folder with important resources for the system (pictures & other data).
	In this release (and in the following ones) the content of this folder is 
	included in the JAR file and it is needed only if there are changes of the
	initial data.
    
    resources/pic/
        - folder with all important pictures for 
          the system 

    resources/dtds/
        - folder containing DTDs for the XML documents
          in which the system serializes its data 
	(tokenizers, constraints, grammars, etc.).

    resources/enc/
        - folder with all encoding correction tables
          (ASCII <-> Unicode) supported
          by the system (34 files)

    resources/ent/
        - folder with all entity conversion tables supported
          by the system (19 files)

    resources/Demo/
        - folder with several demo example files and notes on them

====================================
Example Installation:

Assuming that there is a JDK package installed on the computer 
in folder C:\jdk1.5.0\ (or /jdk1.5.0/ for Unix). If you do not have 
a JDK (Java Development Kit) 1.5.x you can download it 
from http://java.sun.com/ . For versions different from these 
two the ClarkSystem may not work properly (as there are differences in 
the libraries).
    
Step 1:
  Create a new folder where the ClarkSystem will be installed. 
  For example C:\ClarkSystem\ (/ClarkSystem/)
Step 2*: (In case you have the system in a ZIP archive)
  Extract the file ClarkSystem.zip in the new folder.
Step 3:
  Edit the starting file ClarkSystem.bat (or ClarkSystem.uni) 
  is an ordinary text editor:
   - for Windows OS:
     Content of ClarkSystem.bat:
     ----------------------------------------------------------------------
     C:\jdk1.5.0\bin\java.exe -jar -mx140000000 -ms140000000 clarkSystem.jar
     ----------------------------------------------------------------------
     Instructions on the file content:
      - the first element ("C:\jdk1.5.0\bin\java.exe") is the path 
        to the Java virtual machine (java.exe) in the JDK.
        If your JDK package is not installed in this folder 
        (C:\jdk1.5.0\) you have to change the prefix.

      - the third and the fourth elements ('-mx140000000' and 
        '-ms140000000') are important for the memory management of 
        the Java Virtual Machine. If you intend to use larger documents
        (2-3 MBytes) you may need to increase these values (this only 
        in case the Java Virtual Machine indicates "Out of memory" 
        errors in the standard output console). If the Java VM can't start
        at all with an error of the kind "Unable to initialize the 
        virtual machine" or something like this, then the reason might
        be too high values for these parameters.

      - all other parameters remain the same.

      - save the file (if modified) and execute it.

   - for Unix OS:
     Content of ClarkSystem.uni:
     ------------------------------------------------------------------
     cd /ClarkSystem
     /jdk1.5.0/bin/java -jar -mx140000000 -ms140000000 clarkSystem.jar
     ------------------------------------------------------------------
     Instructions on the file content:
     - the first element ("/jdk1.5.0/bin/java") is the path to the Java 
       virtual machine (java) in the JDK. If your JDK package is not
       installed in this folder (/jdk1.5.0/) you have to change the prefix.

     - the third and the fourth elements ('-mx140000000' and 
       '-ms140000000') are important for the memory management of 
       the Java Virtual Machine. If you intend to use larger documents
       (2-3 MBytes) you may need to increase these values (this only
       in case the Java Virtual Machine indicates "Out of memory"
       errors in the standard output console).
       If the Java VM can't start at all with an error of the kind 
       "Unable to initialize the virtual machine" or something like this,
       then the reason might be too high values for these parameters.
       Note: the values ot this parameters MUST be less then the
       size of the SWAP partition of your OS system.

     - all other parameters remain the same.

     - save the file (if modified) and execute it.
       Note: Do not forget to change the mode of the file to executable.


Feedback
--------
For feedback, bug reports, questions and any comments:
- E-mail: clark-support@bultreebank.org

- Homepage  http://www.bultreebank.org/

Because of limited resources, we promise no software support and
give NO WARRANTY WHATSOEVER, but we will try to answer your questions
and fix bugs as best as we can.

(c) Kiril Simov, Alexander Simov, Krassimira Ivanova, Hristo Ganev, Ilko Grigorov

