==============================================================================
                                GROM README
                     Written by Bart Trzynadlowski 2000
==============================================================================

This is the GROM v0.75 documentation, read it before asking questions. GROM is
public domain.

The author can be reached at trzy@powernet.net -- send useful feedback only.
        Special thanks to Kuwanger (http://members.tripod.com/~Kuwanger),
Felipe XnaK, and Later Dude.

0. GROM
GROM is a simple Genesis ROM tool, it can convert SMD format ROMs to BIN
format and display information from the Sega cartridge header regardless of
what format the file is in. Run GROM to find out how to use it.
        GROM checks the extensions of the files you specify on the command
line first, even if the files don't really exist. If the extension is not .smd
or .bin (depending on which command you specify) it will not process the file.
For non-DOS users: remember, the extensions MUST be lowercase. Sonic2.smd and
Sonic2.SMD are different, only the first will be recognized as valid. Multiple
files and wildcards can be used.

You should probably have received the source code, a 32-bit DOS executable,
an ELF FreeBSD/i386 executable, this documentation, and an SMD format text
file.
        Once again: run the program to learn about how to use it. That should
be enough information for anyone.

1. COMPILING
Use gcc (I've tried 2.7.2.1 for FreeBSD, and 2.8.1 for DOS.) I cannot be sure
that other compilers will work. There is only a single source file, grom.c, so
there is no Makefile.

DOS users: Remember to #define DOS at the start of grom.c, this will enable
GROM to accept files with extensions that are not lowercase.

Non-DOS users: Compile normally, make sure DOS mode is not defined. The non-
DOS version will not allow files with capitalized extensions. Keep this in
mind in case you get an error while using GROM which you think should not be
occurring.

3. CHANGE HISTORY

Version 0.75:
        - Special DOS mode added to allow files with capitalized extensions.
          Once again, thanks to Later Dude
        - ELF FreeBSD/i386 binary included
        - UNIX-formatted source code distributed (for easy compilation on non-
          DOS systems)

Version 0.7:
        - More reliable ROM checking added (thank Later Dude for this helpful
          suggestion)
        - Minor modifications to command line interface
        - May contain bugs and incompatibilities with non-DOS systems, let me
          know if you find anything

Version 0.6:
        - Major update! Command line handling has been completely redesigned
        - Multiple files can be specified on the command line
        - Multiple options can be specified as well, their actions will be
          performed in sequence
        - Added a progress indicator
        - Forgot to actually change the error format in the last release, it
          has been done now
          
Version 0.51:
        - Fixed a minor but serious bug which caused segmentation faults on
          some UNIX systems (d'oh!)
        - Changed error message format

Version 0.5:
        - Improved SMD to BIN decoding process, now it decodes 2 bytes per
          pass instead of one and it no longer needs to make an if comparison.
          This is much more efficient
        - Changed some error messages, tidied up comments, removed the
          #include <stdlib.h> because no stdlib.h functions were being used

Version 0.0:
        - Initial release


