Graoumf Tracker 2 source code
=============================



Originally intended to be a commercial application, Graoumf Tracker 2 is now
becoming open source through a GPL license. I (Laurent de Soras) decided to
release the source code because I didn't have time to continue the development
seriously. This software, which was technologically ahead at its creation
date, is now retarded because of the lack of update. However there are already
(still ?) enthusiastic users and it would be a pitty to leave GT2 in the dust.

Graoumf Tracker 2 is usable but not finished at all. Large parts of code still
need to be written, others require bugfixes. I would like to appologize for
the very low quality of the existing code : I learnt coding C then C++ during
GT2 development, and changed several times of coding techniques. It results in
a weird mix of procedural and object oriented code. The general achitecture is
not obvious to understand, and often confusing.

Also comments are mainly in French, which makes them hard to read for non-
French speaking people. I'm sorry about this fact and hope it won't prevent
people to maintain and improve the code.

Since the begining I tried to write cross-platform code, isolating and
reducing platform-dependent code. I think it was the right choice because
Graoumf Tracker 2 knew three OS ports during its lifetime : Atari, DOS then
Windows. For this reason I advice people to continue in this way. For example,
doing a Linux or MacOS X port would be probably pretty quick and easy.



Content
-------

This package is made of :

- src/          : Graoumf Tracker 2 source code + MSVC++ 6.0 project files
- src/rsc_edit/ : Resource editor source code
- gfx/          : Graphic files for user interface
- manual/       : HTML Manual in French language
- doc/          : Some documentation for code

You'll need NASM (available at http://www.web-sites.co.uk/nasm/) to compile
assembly source code for specific routines. If you don't have it or don't want
to use it, you can still use the equivalent C++ source code by undefining some
macros.

The resource editor allows you to add and edit user interface features through
the file rsc01.rsc. The user interface is organized in a tree structure which
should be easy to understand.

In order to run GT2, you'll need at least the gfx files and the rsc file. The
current MSVC projects automatically copies all these files along with the .exe
in the test_release/ directory.

Tabulations are set to 3 characters.
