documentation changes
authorphil <none@none>
Tue, 26 Jan 1999 00:38:58 +0000 (00:38 +0000)
committerphil <none@none>
Tue, 26 Jan 1999 00:38:58 +0000 (00:38 +0000)
INSTALL
NEWS
README

diff --git a/INSTALL b/INSTALL
index b42a17ac4640e9a2bfe5e480e44d0eef3f365928..0f37da123205ecfdcdee3793bde1fcf51305f388 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,31 +1,28 @@
-Basic Installation
-==================
+CACAO specific installation instructions
+========================================
 
-   These are generic installation instructions.
+* CLASSPATH, classfiles & other Java weirdness
+----------------------------------------------
 
-   The `configure' shell script attempts to guess correct values for
-various system-dependent variables used during compilation.  It uses
-those values to create a `Makefile' in each directory of the package.
-It may also create one or more `.h' files containing system-dependent
-definitions.  Finally, it creates a shell script `config.status' that
-you can run in the future to recreate the current configuration, a file
-`config.cache' that saves the results of its tests to speed up
-reconfiguring, and a file `config.log' containing compiler output
-(useful mainly for debugging `configure').
+Make sure, you have classfiles, which work with cacao. A version of
+these can be found at
+ftp://www.complang.tuwien.ac.at/pub/java/cacao/classes.zip.gz
 
-   If you need to do unusual things to compile the package, please try
-to figure out how `configure' could check whether to do them, and mail
-diffs or instructions to the address given in the `README' so they can
-be considered for the next release.  If at some point `config.cache'
-contains results you don't want to keep, you may remove or edit it.
+After the installation of these set the environment variable CLASSPATH
+to the directories where your class libraries are stored. The
+environment variable JAVA_HOME (due to a bug this variable is called
+JAVAHOME in versions less than 0.4) to the java home
+directory. E. g. if you unzipped classes.zip in the directory
+/usr/local/lib/java/classes set the environment variable to
+/usr/local/lib/java/classes and JAVA_HOME to /usr/local/lib/java.
 
-   The file `configure.in' is used to create `configure' by a program
-called `autoconf'.  You only need `configure.in' if you want to change
-it or regenerate `configure' using a newer version of `autoconf'.
+* configuring & compiling CACAO
+-------------------------------
 
-The simplest way to compile this package is:
+  1. Unpack the tar archive (apparently you have done this, otherwise
+     you wouldn't read this file.
 
-  1. `cd' to the directory containing the package's source code and type
+  2. `cd' to the directory containing the package's source code and type
      `./configure' to configure the package for your system.  If you're
      using `csh' on an old version of System V, you might need to type
      `sh ./configure' instead to prevent `csh' from trying to execute
@@ -34,149 +31,8 @@ The simplest way to compile this package is:
      Running `configure' takes awhile.  While running, it prints some
      messages telling which features it is checking for.
 
-  2. Type `make' to compile the package.
+  3. Type make.
 
-  3. Optionally, type `make check' to run any self-tests that come with
-     the package.
-
-  4. Type `make install' to install the programs and any data files and
-     documentation.
-
-  5. You can remove the program binaries and object files from the
-     source code directory by typing `make clean'.  To also remove the
-     files that `configure' created (so you can compile the package for
-     a different kind of computer), type `make distclean'.  There is
-     also a `make maintainer-clean' target, but that is intended mainly
-     for the package's developers.  If you use it, you may have to get
-     all sorts of other programs in order to regenerate files that came
-     with the distribution.
-
-Compilers and Options
-=====================
-
-   Some systems require unusual options for compilation or linking that
-the `configure' script does not know about.  You can give `configure'
-initial values for variables by setting them in the environment.  Using
-a Bourne-compatible shell, you can do that on the command line like
-this:
-     CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
-
-Or on systems that have the `env' program, you can do it like this:
-     env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
-
-Compiling For Multiple Architectures
-====================================
-
-   You can compile the package for more than one kind of computer at the
-same time, by placing the object files for each architecture in their
-own directory.  To do this, you must use a version of `make' that
-supports the `VPATH' variable, such as GNU `make'.  `cd' to the
-directory where you want the object files and executables to go and run
-the `configure' script.  `configure' automatically checks for the
-source code in the directory that `configure' is in and in `..'.
-
-   If you have to use a `make' that does not supports the `VPATH'
-variable, you have to compile the package for one architecture at a time
-in the source code directory.  After you have installed the package for
-one architecture, use `make distclean' before reconfiguring for another
-architecture.
-
-Installation Names
-==================
-
-   By default, `make install' will install the package's files in
-`/usr/local/bin', `/usr/local/man', etc.  You can specify an
-installation prefix other than `/usr/local' by giving `configure' the
-option `--prefix=PATH'.
-
-   You can specify separate installation prefixes for
-architecture-specific files and architecture-independent files.  If you
-give `configure' the option `--exec-prefix=PATH', the package will use
-PATH as the prefix for installing programs and libraries.
-Documentation and other data files will still use the regular prefix.
-
-   In addition, if you use an unusual directory layout you can give
-options like `--bindir=PATH' to specify different values for particular
-kinds of files.  Run `configure --help' for a list of the directories
-you can set and what kinds of files go in them.
-
-   If the package supports it, you can cause programs to be installed
-with an extra prefix or suffix on their names by giving `configure' the
-option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
-
-Optional Features
-=================
-
-   Some packages pay attention to `--enable-FEATURE' options to
-`configure', where FEATURE indicates an optional part of the package.
-They may also pay attention to `--with-PACKAGE' options, where PACKAGE
-is something like `gnu-as' or `x' (for the X Window System).  The
-`README' should mention any `--enable-' and `--with-' options that the
-package recognizes.
-
-   For packages that use the X Window System, `configure' can usually
-find the X include and library files automatically, but if it doesn't,
-you can use the `configure' options `--x-includes=DIR' and
-`--x-libraries=DIR' to specify their locations.
-
-Specifying the System Type
-==========================
-
-   There may be some features `configure' can not figure out
-automatically, but needs to determine by the type of host the package
-will run on.  Usually `configure' can figure that out, but if it prints
-a message saying it can not guess the host type, give it the
-`--host=TYPE' option.  TYPE can either be a short name for the system
-type, such as `sun4', or a canonical name with three fields:
-     CPU-COMPANY-SYSTEM
-
-See the file `config.sub' for the possible values of each field.  If
-`config.sub' isn't included in this package, then this package doesn't
-need to know the host type.
-
-   If you are building compiler tools for cross-compiling, you can also
-use the `--target=TYPE' option to select the type of system they will
-produce code for and the `--build=TYPE' option to select the type of
-system on which you are compiling the package.
-
-Sharing Defaults
-================
-
-   If you want to set default values for `configure' scripts to share,
-you can create a site shell script called `config.site' that gives
-default values for variables like `CC', `cache_file', and `prefix'.
-`configure' looks for `PREFIX/share/config.site' if it exists, then
-`PREFIX/etc/config.site' if it exists.  Or, you can set the
-`CONFIG_SITE' environment variable to the location of the site script.
-A warning: not all `configure' scripts look for a site script.
-
-Operation Controls
-==================
-
-   `configure' recognizes the following options to control how it
-operates.
-
-`--cache-file=FILE'
-     Use and save the results of the tests in FILE instead of
-     `./config.cache'.  Set FILE to `/dev/null' to disable caching, for
-     debugging `configure'.
-
-`--help'
-     Print a summary of the options to `configure', and exit.
-
-`--quiet'
-`--silent'
-`-q'
-     Do not print messages saying which checks are being made.  To
-     suppress all normal output, redirect it to `/dev/null' (any error
-     messages will still be shown).
-
-`--srcdir=DIR'
-     Look for the package's source code in directory DIR.  Usually
-     `configure' can determine that directory automatically.
-
-`--version'
-     Print the version of Autoconf used to generate the `configure'
-     script, and exit.
-
-`configure' also accepts some other, not widely useful, options.
+After this you should have a working version of cacao and cacaoh. How to
+invoke cacao and which class library has to be used is described at the
+CACAO home page (http://www.complang.tuwien.ac.at/java/cacao/index.html).
diff --git a/NEWS b/NEWS
index 7112ea80cd9b38434659a3fc1bc5042e6c9150b9..cab59795cfba9b34cf58207ae76a4e23dca53c13 100644 (file)
--- a/NEWS
+++ b/NEWS
@@ -8,6 +8,15 @@ all the changes in the code.
 * Version 0.40 (released)
 =========================
 
+** mips port
+------------
+
+Now runs on some SGI systems, which are based on the mips architecture.
+
+** multiple bug fixes
+---------------------
+
+Even more java programs work as expected!
 
 
 * Version 0.35 (experimental)
@@ -32,21 +41,30 @@ configure arguments:
 
 Included the new garbage collector as default garbage collector. 
 
-** new just-in-time compiler
-----------------------------
-
-Andi, write something...
-
 * Version 0.30 (released)
 =========================
 
-Andi, write something!!!
+Added unlimited stack for GC and main thread. 
+Some optimzations for instructions which operate on constants. 
 
 * Version 0.20 (released)
 =========================
 
-Andi, write something down here, too!
+Hardware null pointer check added, fixed severe errors in GC/Threads, type
+check and IEEE arithmetic.
+
+* Version 0.20beta (can't remember)
+=========================
+
+There is a completely new JIT compiler which is about 7 times faster and
+produces better code. 
+Multithreading is now supported. 
+A lot of bugs have been fixed.
+
+* Version 0.10 (ancient history)
+==============
 
+The initial version included the old JIT and support for lang, util and io.
 
 ----------------------------------------------------------------------------
 Local variables:
diff --git a/README b/README
index aa706ccbfef16bd07e823d1376ec8e49ae11d66e..7027d77028fd919848b2c164209bf01c149fc019 100644 (file)
--- a/README
+++ b/README
@@ -1,31 +1,27 @@
-************************* README for CACAO version 0.15 ************************
+* README
+========
 
-The current sources of CACAO version 0.15 are a snapshot during development.
-They will change in the near future and are badly documented. This version
-is not intended for public distribution. It is made available only for
-educational and research purposes.
+CACAO is a 64-bit (32-bit versions are planned) Java virtual machine
+for Alphas and Mips processors.
 
-To use the CACAO sources put the cacao015.tgz file in a newly created
-directory and uncompress it using gzip and extract the files using tar.
-Make sure you have installed gmake. Enter:
+The current sources of CACAO version 0.30 are a snapshot during
+development.  They will change in the near future and are badly
+documented. This version is not intended for public distribution. 
+It is made available only for educational and research purposes.
 
-make config-alpha
-make
+You will find the licensing condition in the file COPYING.
 
-After this you should have a working version of cacao and cacaoh. How to
-invoke cacao and which class library has to be used is described at the
-CACAO home page (http://www.complang.tuwien.ac.at/java/cacao/index.html).
+For installation instruction, please refer to INSTALL.
 
-Under Linux this version currently works only using the option -cf.
-If you want to use the Digital Unix C-compiler change the variable $CC
-in the Makefile from gcc to cc.
+New versions, updates and general information can be retrieved from
+http://www.complang.tuwien.ac.at/java/cacao
 
-The Sparc port is unfinished and not working. So typing "make config-sparc"
-makes no sense in the moment. Threads are currently also not supported.
+In case of questions questions or to report a bug, send mail to
+cacao@complang.tuwien.ac.at; in case of very, very urgent questions
+please contact Andreas Krall (andi@complang.tuwien.ac.at) directly.
 
-For questions mail me at cacao@complang.tuwien.ac.at, for very urgent
-questions mail me at andi@complang.tuwien.ac.at.
 
-Have fun with CACAO
+Enjoy the ride,
+-- the cacao team.
+
 
-       Andreas Krall