README ObjectSpace JGL Version 3.1.0 ----------------------------------------------------------------------- CONTENTS Overview of JGL - Welcome To JGL! - Reporting Bugs and Requesting Features - Contacting ObjectSpace Installing and Running JGL - Installing the Microsoft Windows distribution - Unpacking the UNIX distribution - Environment PATH and CLASSPATH - Compiling JGL Examples - Installation Troubleshooting ======================================================================= OVERVIEW OF JGL ======================================================================= ----------------------------------------------------------------------- WELCOME TO JGL! ----------------------------------------------------------------------- All Java programmers need a library of reusable data structures. The Java Developer's Kit (JDK) only contains three data structures - a Vector, a Stack, and a Hashtable - which is hardly sufficient for serious software development. In addition, the JDK does not include algorithms for sorting, filtering, and other common tasks. JGL was created by ObjectSpace to address these concerns. JGL includes highly optimized data structures such as sequences, maps, sets, queues, and a stack. There are over 40 reusable algorithms that work with the JGL containers, the JDK containers, and native Java arrays. With complete HTML API documentation and a comprehensive HTML user guide packed with over 100 examples, JGL is very easy to learn and use. ----------------------------------------------------------------------- REPORTING BUGS AND REQUESTING FEATURES ----------------------------------------------------------------------- Please report bugs and feature requests to jgl@objectspace.com Visit the ObjectSpace web site at http://www.objectspace.com/jgl for the most recent information. ----------------------------------------------------------------------- CONTACT INFORMATION ----------------------------------------------------------------------- For additional information on ObjectSpace technology and services, contact our North American headquarters. ObjectSpace, Inc. 14881 Quorum Dr. Suite 400 Dallas, TX 75240 Phone: 972.726.4100 or 1.800.OBJECT.1 Fax: 972.715.9099 E-Mail: info@objectspace.com WWW: http://www.objectspace.com ======================================================================= INSTALLING AND RUNNING JGL ======================================================================= IMPORTANT: Please make sure you understand the Copyright and License information (in the files named COPYRIGHT.TXT and LICENSE.TXT) before installing this release. The JGL release version 3.1.0 requires a JDK 1.1 compliant Java distribution. It will not function with a JDK 1.0 distribution. Features new to the JDK 1.1 specification are necessary for JGL. The Voyager extensions require ObjectSpace Voyager 2.0 or later because of the package names. ----------------------------------------------------------------------- INSTALLING THE MICROSOFT WINDOWS DISTRIBUTION ----------------------------------------------------------------------- Execute the InstallShield executable which will perform the installation and unpack the distribution. It will query for needed information such as the installation root directory. WIN95 Specific -------------- Note that the installation will ask whether or not the AUTOEXEC.BAT file should be modified. The modifications consist of adding entries to the CLASSPATH environment variable. This modification does not have to be done through InstallShield. It may be done manually to the AUTOEXEC.BAT file. After making changes to the AUTOEXEC.BAT file, you must reboot your computer to have the changes take effect. WINNT Specific -------------- Under Microsoft Windows NT, the InstallShield program modifies the HKEY_CURRENT_USER\Environment strings for the CLASSPATH variable. It is not necessary to reboot the system after these changes are done, but you will need to exit and restart any running programs (including MS-DOS windows) to have the settings take effect. ----------------------------------------------------------------------- UNPACKING THE UNIX DISTRIBUTION ----------------------------------------------------------------------- First, unpack one of jgl3.1.0.tar.Z jgl3.1.0.tar.gz into a chosen installation root directory. This directory is subsequently referred to as $(INSTALLATION_ROOT). ______ .tar.Z To unpack the .tar.Z distribution, place the file jgl3.1.0.tar.Z in the directory $(INSTALLATION_ROOT). Then type cd $(INSTALLATION_ROOT) uncompress jgl3.1.0.tar.Z tar xvf jgl3.1.0.tar ______ tar.gz To unpack the .tar.gz distribution, place the file jgl3.1.0.tar.gz in the directory $(INSTALLATION_ROOT). Then type cd $(INSTALLATION_ROOT) gunzip jgl3.1.0.tar.gz tar xvf jgl3.1.0.tar If there are problems with gunzip, try using gzip -d jgl3.1.0.tar.gz Second, the CLASSPATH environment variable must be modified as detailed below. The particular dot file to be modified is dependent on the particular version of UNIX in use. It may be one of .profile, .cshrc, .bashrc or .mycshrc. The environment command may be one of set, export, or setenv. ----------------------------------------------------------------------- ENVIRONMENT CLASSPATH for Windows and UNIX ----------------------------------------------------------------------- The CLASSPATH environment variable must include the following entry: $(INSTALLATION_ROOT)/lib/jgl3.1.0.jar $(INSTALLATION_ROOT) is the directory where the JGL release is installed and unpacked. The separator "/" should be "\" on Microsoft Windows. ----------------------------------------------------------------------- COMPILING JGL EXAMPLES ----------------------------------------------------------------------- Example Java applications and applets using JGL are under directory $(INSTALLATION_ROOT)/examples. The examples are not in any particular package, so the current directory (".") should be on the CLASSPATH as well for these to execute. ----------------------------------------------------------------------- Copyright (c) 1996,1997 ObjectSpace, Inc.