#
# README
#
#   Demers, November 1, 1988 4:30:09 pm PST
#   Weiser, December 1, 1989	
#   Boehm, September 17, 1991
#

See below for installation instructions.

Some terms:

CONFIG:  A config is a build of the system with a particular set of switches.
At one time there were many kinds of configs, like Threads, PseudoThreads,
StandAlone, and SoftCard.  Currently there are only two: Threads and
OptThreads.

It is easy to add new configs: the makefile explains, and gives examples of,
how.

This subtree contains the following directories, which are filled in by make:

INCLUDE:

    header files

BIN:

    A subdirectory for each config, containing executable files associated
    with that config.

LIB:

    A subdirectory for each config, containing libraries associated with the
    config.
    
    In particular, for each config there is a library named "xr.a" which
    contains the components of the runtime itself.  The object file XRRoot.o
    has undefined external symbols that cause the entire runtime to be loaded.

SRC:

    A single directory containing all sources.  (Pointing dbx at this directory
    can be useful.)

MAN: 

    Manual entries.

INSTALLATION INSTRUCTIONS:

0. Don't be afraid to read the makefile ... it's pretty heavily commented.

1. In fact, the first thing you need to do is edit the makefile.  It starts
out with a couple of variables:

    XR_HOME = ...
    INSTALL_MAN = ... (e.g. /usr/local/manl)

These should be changed to reflect local conventions at your site.

2. Change the default values of environment values in boot/XRDBX.csh
to ones that are reasonable for your site.  (Nothing else depends
on this.  If you omit doing this, you will simply end up with a
suboptimal XRDBX in the BIN directory when make finishes.  This will
make it even harder to debug in PCR.)

3. Then execute

    make install1

This will recompile every config, then rename the DIST subdirectory to the
actual PCR version and create a symbolic link to it named INSTALLED.

4. Once step 3 has completed, optionally execute

    su bin
    ...
    make install2

(replace "bin" above by whatever user owns your INSTALL_MAN directory; in some
installations that's root (shudder)).  You may also want to move some
executables from BIN to a more public place.

