README

README
------

This is SIS 1.3, an unofficial release of SIS, the logic synthesis system
from UC Berkeley.  SIS is no longer supported, but there are still many
people still interested in this software, hence this release.

If you have not already done so, please have a look at MVSIS, a successor
to SIS, at:
    http://www-cad.eecs.berkeley.edu/Respep/Research/mvsis/

While MVSIS does not have all the functionality of SIS at this time,
it is both actively maintained and continually growing, and is very
suitable for research and development of core synthesis algorithms.

The primary features added on top of SIS 1.2 are:
  - a configure system based on autoconf, making building and installing
    the software simpler
  - various patches to allow compilation under Linux (glibc 2.2/2.3)
  - Automated integration of CUDD when available


Systems/Portability
-------------------

Testing is extremely limited due to lack of resources, but various
versions of SIS 1.3 have been successfully built on:
  - Linux Intel x86 (Redhat 8.0/9.0, Debian 3.0, glibc 2.2/2.3)
  - Mac OSX
  - Windows (NT with Cygwin)

Some other platforms should be okay with little or no modifications.
However, SIS is old software, and may not build or run correctly on
modern systems.  If you have patches to get things to build on other
platforms, or can help in the porting process (either by providing
debugging help, or providing access to a suitable machine), this would
be greatly appreciated.


Requirements
------------

You will need the following software to build SIS.  Tested versions
are indicated in parentheses.  Other versions may or may not work.
  - GNU gcc (3.2.2)
  - GNU make (3.79.1)


Build/Installation
------------------

Make sure your current working directory is the one which contains
this README file and the configure script, and type:
    ./configure --prefix=<target install directory> <other options>
    make
    make install

The target install directory will be created if it does not already exist.
You should specify a location where you have write access for the install
directory.  The source directories can be deleted after the install,
if desired.  For this reason, it is recommended to make the install
directory a different directory than where the sources are located.

You can still run the executables from the build directories without
doing a "make install", but some minor things will not work correctly
(e.g. the "help" command).

By default, debugging symbols in the binaries and libraries are not
removed.  If you would like to remove debugging symbols for faster/smaller
executables, instead of "make install" use:
    make install-strip

Note that this only strips the executables which are installed;  the
temporary files created inside the build tree remain unstripped, and
the installed library libsis.a is not stripped.  To strip libsis.a,
use the command:
    strip -g libsis.a

The utility xsis requires use of the X Window libraries.  Normally this
is automatically detected with configure, but sometimes the test fails.
You can disable compilation of xsis by adding --without-x to the
configure options:
    ./configure --without-x <other configure options>

To get a full list of the options used by the configure script, use
the command:
    ./configure --help


CUDD
----

SIS can be configured to use the optional University of Colorado BDD
package (CUDD).  First obtain CUDD from:
    http://vlsi.colorado.edu/~fabio/

Untar the CUDD sources in some convenient directory, then use the
--with-cudd option for configure:
    ./configure --with-cudd=<CUDD source directory> <other options>

Then build and install SIS as normal.  This has been tested with CUDD
2.4.0.


Contact
-------

Bug reports, patches, questions and comments are welcome.  Please send
correspondence to:
    <pchong@ic.eecs.berkeley.edu>