SUPPORTED PLATFORMS
-------------------
Linux on X86 machines
Mac OSX on X86 machines
Solaris on Sun machines

REQUIREMENTS
------------
Installing Hancock from binary requires things:
  1. The appropriate Hancock tarball for your platform:

        hancock.2.0.2.x86-linux.tar.gz     for Linux on X86 machines
	hancock.2.0.2.x86-darwin.tar.gz  for Mac OSX on X86 machines
        hancock.2.0.2.sparc-solaris.tar.gz for Solaris on Sun machines. 
						(requires Sun's compiler)
     available from the Hancock web page:
        www.research.att.com/projects/hancock. 

  2. A C compiler.
 
INSTALLATION
------------
1. Download the appropriate Hancock tarball from the
   Hancock web site, www.research.att.com/projects/hancock.

2. Unzip and untar the file, to produce the directory hancock.

3. The installation process is parameterized by a machine description
   file, templates for which are located in directory hancock/install.
   The file install_form is generic, while the file if.build contains
   the install form used to create the distribution.  Copy
   the file if.build to create a machine description for 
   your machine, which we will call if.your_machine.
   This file may need to be further specialized depending on your
   particular machine configuration.   Comments in the file
   indicate how to use it to describe your machine.  

   Note that the install forms used for the source code installation
   and the binary code instalations are different.  

4. In the hancock directory, run the installation script, invoking it
   with the path to the file describing your machine:
     
              install/install.sh if.your_machine

5. The installation process finishes by running a regression suite and
   using diff to compare its output to a sample output.  If there are no
   differences, then Hancock reports a successful installation.

6. After installation, the Hancock compiler can be found in bin/hcc.

7. After installation, if you have sml version 110.65 or higher
   already installed on your machine, you may replace the file
   lib/run.xxxx, where 'xxxx' describes your machine and operating
   system, with a symbolic link to the location of the sml executable
   on your machine.  This executable is located in the directory
   bin/.run of your local sml installation. 


FILE YOU NEED TO CREATE
-----------------------
if.my_machine, using the file
  hancock/install/if.build
as a template.

DOCUMENTATION
-------------
The hancock directory contains a subdirectory manual, which
includes within postscript and pdf versions of the manual.
This document describes the Hancock language and compiler interface. 

KNOWN BUGS
----------
Writes into directories, maps, and pickles declared as const will
affect their in-memory representation.  The on-disk representation 
will not be affected.

CONTACT INFORMATION
-------------------
Report bugs to hancock@research.att.com.