--------------------------------------------------------------------------------
                                        README
--------------------------------------------------------------------------------

                                       KJC SUITE

                                  http://www.dms.at/kopi

--------------------------------------------------------------------------------
VERSION:	1.4F
RELEASED:	23 May 2000	

--------------------------------------------------------------------------------
  THIS PACKAGE IS PART OF "KOPI", PLEASE SEE THE LICENSE PROVIDED WITH
  "KOPI" IF YOU WISH TO USE, MODIFY OR DUPLICATE THIS SOFTWARE.

--------------------------------------------------------------------------------
CONTENTS

FILES
  README       This file
  Makefile     The makefile to build the executables from the source code

DIRECTORIES:
kjc suite:
  util         Some utilitiy classes shared by all dms tools
  compiler     Some utilitiy classes shared by all kjc tools
  jperf	       A perfect hashcode generator
  optgen       An option generator based on gnu.getopt
  msggen       A Message class generator
  classfile    A package to handle classfile
  optimizer    An optimizer package for java bytecode
  lexgen       A lexer generator
  ksm          A .ksm assembler to .class
  dis          A .class disassembler to .ksm
  memcnt       An instrumenter for instance counting
  kjc          A java compiler

kopi:
  sqlc         A simple SQL parser
  mkjc         A tool for AST generating from source code like specification
               used by xkjc
  xtype        A set of new primitive type for the KOPI language
  xlib         A library for the KOPI runtime
  xkjc	       A java compiler with embedded SQL and operator overloading
  xoper        A definition of operator for KOPI primitive types
  dbi	       A SQL transformer
  ikjc	       An remote incremental compiler (client/server mode) for kjc
  kopi	       A jar-Main for all kopi tools

visual kopi:
  lpr	       An Lpd-client implementation in Java 
  mailer       A SMTP-client in Java that send mail with attachment
  vlib	       The librarie of visual kopi
  vkjc	       A form/report/document generator for all visual kopi files

documentation:
  doc	       The kopi documentation in HTML and ps

--------------------------------------------------------------------------------
OTHER PACKAGES YOU NEED (Their runtime are included in kjc.jar)

  GNU GETOPT
    The parsing of the arguments of the command line is made with gnu.getopt: 
    http://www.urbanophile.com/arenn/hacking/download.html 

    This is a port of the GNU getopt functions based on the versions contained 
    in glibc 2.0.6. 

  ANTLR
    We use a MODIFIED version of ANTLR 2.6.1 (http://www.antlr.org).
    You can retrieve the Java files needed to build kopi through:
      cvs -d :pserver:guest@www.dms.at:/cvs/public checkout antlr

--------------------------------------------------------------------------------
INSTALLATION

  Just type: javac -d dest *.java in every directory following the
  order specified upper (CONTENTS) or type make in kopi directory

  Where dest is the location where you want to put your classes. This directory
  must be in your classpath.

  CONFIG:  you may need to edit Makefile to specify your java compiler
           default is jikes.

  WARNING: if you use kjc as default compiler, the dest directory should appear
           before the kjc.jar file in your class files because this package is
           included in kjc.jar.

--------------------------------------------------------------------------------
CHANGES

  Added diagnostic messages in version 1.4A
 
  Added visual kopi (vlib / vkjc) to kopi distribution

--------------------------------------------------------------------------------
KNOWN BUGS

--------------------------------------------------------------------------------
FUTURE IMPROVEMENTS

--------------------------------------------------------------------------------
REPORTING BUGS

  Please, report all bugs to http://www.dms.at/kopi.
