File: sather/doc/README
Author: Stephen M. Omohundro
Add on: Heinz W. Schmidt
Created: Mon May 20 14:28:13 1991
Copyright (C) International Computer Science Institute, 1991

This directory contains several kinds of documentation about the
Sather system. 

STARTING: A short tutorial description of getting started with
   Sather. Shows how to set up your environment, compile programs, use
   the emacs editting facilities, and run the debugger.

INSTALL: Instructions for installing the Sather directories.

README: This file.

cs_options.txt: A description of the command line argument
   compiler options available for "cs".

contrib.txt: How to contribute new classes to the Sather library.

sdb_info.txt: Quick introduction to the debugger.

eif_diff.txt: An article summarizing the differences between Sather
   and Eiffel that appeared in "Eiffel Outlook".

lib_style.txt: A description of the sylistic conventions used in
   the library classes. These should be followed in submitting new
   classes to the library.

license.txt: The Sather library general public license describing
   restrictions on using Sather library classes. 

manual.frm, manual.ps.Z, manual.txt: Three forms of the Sather manual.
   ".frm" is a Framemaker file, ".ps.Z" is a compressed file ready 
   to be sent to a PostScript printer (such as an Apple Laserwriter II), 
   ".txt" is an automatically generated ASCII text version without 
   pictures and with somewhat awkward spacing.

sac.txt: A description of the Sather to C interface generator.

SUMMARY: A one page overview of the Sather system.

-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
The directory contains some technical reports related to Sather.
You will find these and perhaps other relevant reports in
icsi.ftp.berkeley.edu pub/techreports

TR91031.ps.Z: A compressed PostScript version of ICSI TR-91-031, by
   Jerome A. Feldman, Chu-Cheow Lim, Franco Mazzanti: pSather
   monitors: Design, Tutorial, Rationale and Implementation.

TR91034.ps.Z: A compressed PostScript version of ICSI TR-91-034, by
   Chu-Cheow Lim and Andreas Stolcke: Sather Language Design and
   Performance Evaluation.

TR91047.ps.Z: A compressed PostScript version of ICSI TR-91-047, by
   Heinz W. Schmidt and Stephen M. Omohundro: CLOS, Eiffel and Sather
   - A Comparison.

To print one of the reports do 
	zcat <TR> | lpr -P<yourprinter>
The reports are in US format and may not print on a laser writer set
up for European DINA4 format. We had no problems printing them on a
Sparcprinter setup for DINA4 paper.

-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
The directory contains a number of automatically generated class
descriptions. If you have Emacs at your site you can recreate this to
get a perhaps more up-to-date description. We include these
for users who do not have Emacs around.


cs_class.txt: Automatically generated documentation for the
   compiler classes.

sdb_class.txt: Automatically generated documentation for the
    debugger classes.

lib_class.txt: Automatically generated documentation for
   all library classes except the xview classes (which are listed
   in xview_classes.txt).

xv_class.txt: Automatically generated documentation for the
   xview classes.
