Welcome to GMOD, a music module player for Linux and the Gravis Ultrasound card.

The following module formats are supported:
	4/6/8 channel MOD
	8 channel 669
	MultiTracker (MTM)
	ScreamTracker III (S3M)
	UltraTracker (ULT)

General Requirements:

1) Linux kernel configured with GUS sequencer drivers.  The drivers
	must be version 2.90-2 or greater (do cat /dev/sndstat to check).  The
	drivers must be configured with MIDI support.  The latest alpha
	drivers can be found at ftp.funet.fi in /pub/Linux/ALPHA/sound.

2) A GUS card

Additional Requirements to compile the source with X support:

1) libfwf 3.71 with patches applied (libfwf.patch).  The library can be
	obtained from ftp.let.rug.nl in the /pub/FWF directory.

2) libXpm

3) XFree 3.1 (or 3.1.1).  XFree 2.1 may also work.

Additional Requirements to use the precompiled xgmod binary:

1) XFree 3.1 or 3.1.1

2) libXpm 4.3 or greater

3) libc 4.6.27 or greater

4) VoxKit v2.90-2 or later

Additional Requirements to use the precompiled gmod binary:

1) libc 4.6.27 or greater.

2) ncurses terminfo database

3) VoxKit v2.90-2 or greater

*** THE KERNEL MUST BE MODIFIED IN ORDER FOR MAIN VOLUME CONTROL TO WORK ***
*** PROPERLY IF LINEAR VOLUME SUPPORT IS USED.                           ***

If the kernel is not modified, linear volume (in version 2.5+ of the VoxKit
drivers) will still work, but main volume control (using the '-v' option of
gmod, and possibly by S3M modules) will not.  To enable linear volume, edit
the Makefile and define LINEAR_VOLUME.  To modify the kernel, go into the
/usr/src/linux/drivers/sound directory AFTER doing a make config, and add the
following line to local.h:
#define GUS_USE_CHN_MAIN_VOLUME
and re-compile.  The line will need to be added whenever the kernel is
re-configured.

COMPILING:

Two Makefiles are included with this package.  Use "Makefile" to produce
xgmod (gmod with an X interface), or use "Makefile.gmod" to produce gmod
(gmod without the X interface).  Edit the "DEFINES" and "LIBS" lines in
each file to match your system setup and preferences.  Always do 'make clean'
before compiling a new version to remove any old object files.

The contrib directory contains contributed patches which may be applied before
compiling.  Use them at your own risk.

INSTALLATION:

Doing 'make install' will compile and install the binaries in the location
specified in the makefile.
- OR -
Copy/move the binaries to whatever directory you normally keep your
executables in.  Xgmod.ad and Xgmod-color.ad should be installed in your
app-defaults directory as Xgmod and Xgmod-color, respectively.

For more information, refer to the man pages (gmod.1 and xgmod.1) and
ChangeLog.

Please send any comments, suggestions, etc. regarding this version to me,
Andrew J. Robinson (robinson@cnj.digex.net).
