CHANGES		- changes between this version of COOLMUD and the previous one
COPYRIGHT	- copyright information
README		- this file (doncha love it)
src/		- source for COOLMUD
bin/		- contains the source for COOL databases.  also where the
		  the COOLMUD executables are placed.

To use coolmud:

1)  Compile the source by cd'ing to the src directory, modifying the
    Makefile for your system, and typing 'make'.  This will create
    the 'cm' and 'compile' executables in the bin directory.

2)  cd to the bin directory, and edit the appropriate .cfg files.
    The .cfg files indicates which remote servers a server should
    connect to on boot-up. east.cfg and west.cfg are used by
    east.db and west.db respectively (see below).

2)  Compile the COOLMUD databases by make'ing the appropriate dbase:

	make		- creates two connected COOLMUD databases
	make west.db	- creates only the western db

    This will create three files for each db:  a .db, .dir and .pag
    file.  COOLMUD uses a dbm-format dbase. 

    WARNING:  Recompiling with existing db files is DANGEROUS.  If you're
    unsure, do 'make rm' to get rid of the existing db's.  Make sure,
    of course, that there's nothing in the db's you want, first.

3)  Start the database by typing
	./cm <dbaseprefix>
    For example,
	./cm west
    The server will look for <prefix>.db, <prefix>.dir, <prefix>.pag, and
    <prefix>.cfg.  <prefix>.cfg should contain the names of any remote
    servers, plus cache configuration parameters.  (You may also use the
    'restart' shell script to start cm; see bin/restart).

COOLMUD has been successfully compiled under SunOS 4.1, Ultrix 4.2,
BSD and HPUX, and on MicroVAX-II, DECsystem5000, Sparc and NeXT
architectures.

If you make any changes or plan to redistribute the source to
COOLMUD, _check the COPYRIGHT file first_.

Bug reports should:

o   contain the COOLMUD version number, machine architecture, operating
    system, and conditions of error.
o   consist of a stack trace from dbx or gdb.
o   be sent to sfwhite@sciborg.uwaterloo.ca, with 'COOLMUD' in the
    Subject: line.
o   be descriptive.  The more information you give me, the better chance
    I have of finding and fixing the bug.

Stephen White
sfwhite@sciborg.uwaterloo.ca