------------------------------------------------------------------------------

                                   ATOM-4

                                     by
                                 H. S. Teoh

                                  Dec 2002

------------------------------------------------------------------------------


INSTALLATION INSTRUCTIONS


I. REQUIREMENTS

Software Requirements:
	POSIX-compliant system (currently tested under Linux 2.4)
	Ncurses (other curses-based libraries may work, but they have not
		been tested)
	X11R6 (currently tested under XFree86)

Build Requirements:
	Cons 2.2.0 or greater
	Perl 5.005 or greater (basically, requirement of Cons)
	GCC 2.95 or greater (currently tested with GCC 3.2. Other C++
		compilers may work, but they have not been tested)
	X11R6 development libraries (including libXpm)
	prog/lib libraries (should be included in the same archive you got
		Atom-4 from)


II. BUILDING AND INSTALLATION

You will probably need to build the prog/lib library first. To do that,
simply cd to the root directory of the prob/lib source tree and type
	cons .

To build Atom-4, simply type
	cons .

from the root directory of this source tree, and Cons should take care of the
rest. The resulting binary will expect to find its data files in the data/
subdirectory in the source tree, however; for installation purposes you may
need to configure the build process as necessary.

The Construct script can be configured using the following arguments:

BINDIR=$dir		Where to install Atom-4 binaries
COMPILER=$binary	Compiler to use (default: g++)
DATADIR=$dir		Where data files should be installed
MANDIR=$dir		Directory to store manpages
REALDATADIR=$dir	Where Atom-4 should look for data files (default
			is $DATADIR; this option is mainly for packaging
			builds where the build-time dir is different from
			the run-time dir)
PROGLIBPATH=$dir	Path to prog/lib libraries (default: #../lib)
X11LIBPATH=$dir		Where to find X11 libraries (default: /usr/X11R6/lib)
DEBUG=1			Build with debugging symbols

These arguments are passed to Cons during the build. For example, to build
and install the Atom-4 binary into /usr/games, and the data files into
/usr/share/games/atom4, you would run:
	cons . BINDIR=/usr/games DATADIR=/usr/share/games/atom4

Currently, the Construct script does not auto-detect X11 libraries and such;
you will have to specify this explicitly using X11LIBPATH=... if your X11
libraries are not in /usr/X11R6/lib.

