/*

Z License


This software is being provided to you, the LICENSEE, by the 
Massachusetts Institute of Technology (M.I.T.) under the following 
license.  By obtaining, using and/or copying this software, you agree 
that you have read, understood, and will comply with these terms and 
conditions:  

Permission to use, copy, modify and distribute without fee for research 
and educational purposes only, this software and its documentation 
without fee or royalty is hereby granted, provided that you agree to 
comply with the following copyright notice and statements, including the 
disclaimer, and that the same appear on ALL copies of the software and 
documentation, including modifications that you make for internal use or 
for distribution:

Copyright 1993 by the Massachusetts Institute of Technology.  All
rights reserved.

THIS SOFTWARE IS PROVIDED "AS IS", AND M.I.T. MAKES NO REPRESENTATIONS 
OR WARRANTIES, EXPRESS OR IMPLIED.  By way of example, but not 
limitation, M.I.T. MAKES NO REPRESENTATIONS OR WARRANTIES OF 
MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF 
THE LICENSED SOFTWARE OR DOCUMENTATION WILL NOT INFRINGE ANY THIRD 
PARTY PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.   

*/

This document contains the following items:
1. Information about TIM.
2. Directions for installing TIM.
3. Address for sending comments to the authors.

----------------------------------------------------------------------------
1. Information about TIM

TIM is a timing verification and optimization tool that has been
developed for two-phase, level-clocked circuitry.  TIM performs a
variety of functions on two-phase, level-clocked circuitry such as
timing verification, clock tuning, sensitivity analysis, retiming for
maximum speed of operation, and retiming for minimum number of
latches.  TIM also includes commands for performing timing
verification, clock tuning, and retiming on conventional
edge-triggered circuitry.

The tool as well as some experiments that were performed with it are
described in the three papers (in postscript format) in the papers/
directory.

The help/ directory provides help for TIM's commands.

The source code of the commands for two-phase circuitry can be found
in the files approx.c, sensitivity.c, and symm_state_min.c.  The
source code of the commands for edge-triggered circuitry can be found
in the files edge_triggered.c, and edge_state_min.c.  The files
priority.c, util.c, find_period.c, and getopt.c provide utilities.
The code in convert.c converts networks into the graph representation
used by TIM.

----------------------------------------------------------------------------
2. Directions for installing TIM

This version of TIM can be included in the SIS tools from UC Berkeley.
To make SIS with TIM included follow the steps of the procedure below.

- Create a directory for TIM.  Move into this directory all the files
  and subdirectories about TIM that you obtained from ftp.

- Get SIS from Berkeley and install it on your system.

- Find out where SIS's include/ and lib/ directories are and enter them in
  the Makefile that we provide with TIM.

- Type "make sis" in TIM's directory.

A new copy of SIS with TIM included will now be in TIM's directory.
In order to use TIM on a circuit, you must first read-in a library and
the desired circuit.  You can then issue any of TIM's commands.  Each
command of TIM is prefixed by the string "TIM_".

NOTE: The reason why we provide sis.h and clock.h is because there was an
      error in clock.h where it referenced an object in delay.h before
      it was defined.  This line was commented out of the clock.h that we
      provide.  The sis.h that we provide is just a copy of the original
      sis.h so that the local clock.h is used instead of SIS's clock.h.  
      If this bug is fixed in your version of SIS, you may delete these 
      two files from the local directory.

NOTE: Our code is initialized by the sis code through one call in the
      sis_init.c file.  If your version of sis_init.c is newer, you may
      just want to add our initilization call (a call to init_routines)
      to your sis_init.c file and put it in TIM's directory.

NOTE: The Makefile we provide uses gcc as the C compiler.  You may
      wish to change this to use a different C compiler.

----------------------------------------------------------------------------
3. Address for sending comments to the authors

All comments, suggestions etc should be mailed to timing@lcs.mit.edu.