===========================
README.txt file for SpiTran
===========================

This directory contains the SpiTran Java application. SpiTran is a graphical
user interface for the s2ibis Spice-to-IBIS translator. You are free to use,
modify, and redistribute this software. See the copyright legends contained
in the source code.

===========================
INSTALLATION REQUIREMENTS
===========================

The s2ibis2 software must be installed prior to running SpiTran. Several versions
of s2ibis2 can be obtained from links on the "FREE Tools for IBIS modeling" web
page at:

  http://www.eia.org/EIG/IBIS/tools.htm

A version 1.2 Java Runtime Executable is also required. As a minimum, a JRE
kit must be installed. The full Software Developers Kit (SDK) may optionally
be installed, and will serve just as well. Obtain the latest installers from
one of the following locations:

  http://java.sun.com/products/jdk/1.2/		For Solaris and Windows
  http://java.sun.com/cgi-bin/java-ports.cgi	Other platforms

You will also need one of the Spice simulators supported by s2ibis. These
are: SPICE2 SPICE3 HSPICE PSPICE SPECTRE

To install SpiTran simply unpack the zip file. This distribution contains:

README.txt	You are here.

data		Data files such as icon images used by SpiTran.
doc		Documentation files. Open index.htm in your web browser to find links
		to these.
examples	Files that you can use to try out SpiTran. See above.
java		Java class files for running SpiTran. The source files
		are here also. If you have the SDK and know Java, you can modify
		the source and recompile the class files.
spitran.bat	A script for starting SpiTran in Windows. Double-click this in
		a file browser window to start.
spitran.csh	Run spitran.csh to start SpiTran on Unix or Linux.

The startup scripts assume that the working directory is the one containing the
scripts. Do not attempt to run SpiTran from another directory. If you create
a Start menu entry for SpiTran in Windows, set the working directory property
of the shortcut to the SpiTran directory.

===========================
RUNNING SPITRAN
===========================

On Windows NT double-click the spitran.bat icon.
On Unix or Unix-like operating systems run spitran.csh in a compatible shell such as csh.
Open index.htm in a web browser for help using SpiTran, including instructions for trying
out the examples. You can also view help by running "spitran.bat -help" (or "spitran.csh
-help" on Unix).

===========================
RELEASE NOTES
===========================
This is SpiTran release 1.0. It is a preliminary release. Send bugs, suggestions,
or code changes to mikelabonte@cadence.com. Also, see the usability evaluation report
at doc/usability/index.htm. This contains a list of known improvements that SpiTran needs.

