INSTALL: some notes about the source installation of the SCRC
--------

Requirements:

- a Unix-like operating system (Solaris 5.5 (default), SunOS 4.1, NetBSD 1.3.x,
  Linux 2.2 are verified to work)
- the GNU C++ compiler g++ (version 2.95.2 is verified to work)
- the scanner generator flex (version 2.5.2 or newer)
- the parser generator bison (version 1.24 or newer)
- a gmake compatible make (BSD style make is fine)


Installation:

- unpack the distribution archive
  => gtar xvzf scrc-1.0.tar.gz
  => cd scrc-1.0
  (for systems without symbolic links, e.g. GNUWIN32, please use the
  archive scrc-1.0-3.tar.gz which contains copies of files
  instead of symbolic links)
- modify the file Makefile.macros to reflect your local compiler
  environment (adjust the SPECC path and the target architecture
  macros; 5 architectures are already prepared, so you probably just
  need to activate the right one)
  => vi Makefile.macros
- compile the SpecC system
  => make all
  if anything goes wrong, correct your settings in Makefile.macros
  and try again; in order to recompile everything, use
  => make clean all
- install the system
  => make install
  or, if you also want to create an archive of the binary distribution,
  do this instead
  => make bindist
  finally, if you want to install the header and library files for the
  development of SpecC tools, do afterwards
  => make install-devel
- test the system
  => make test
  this should result in a (quite long) test session with the following
  message at the end: "All tests successfully completed.";
  if the tests do not run successfully, go back to your settings
  in Makefile.macros;
  if you have it, you might also want to use purify for the test
  => make puretest
- Congratulations, your system is now installed and ready to run!
  You might want to copy the examples to your work directory
  and try them, e.g.:
  => mkdir work
  => cd work
  => cp $SPECC/examples/simple/* .
  => source $SPECC/bin/setup.csh
  => make
  => ...


Bug reports:

- the SpecC reference compiler currently consists of
  more than 70000 lines of code
- the SpecC compiler contains bugs (see BUGS for known bugs)
- if you encounter a problem which you think is a bug, don't hesitate
  to contact us; you can find contact information in the COPYRIGHT file;
  however, please be aware that we cannot fix everything at once, but
  we will try to fix as much as possible as soon as possible


Enjoy!

Rainer Doemer, May 31, 2001.
