
---------------------------------------------------------
src-readme.txt
---------------------------------------------------------

This file is a simple attempt at explaining some subtleties of the
NeoPop source code. It will eventually turn into a sort of FAQ.
If you feel I have omitted something that isn't as obvious as I thought
it was then let me know! It's difficult to see this project from the
point of view of an outsider...



1.	Additional include paths
============================

In order to simplify the code layout and readability, I have opted
to define some additional include paths. These are (for all builds):

.\Common\,
.\TLCS900h\,
.\Z80\

The base directory in this case is 'NeoPop-Src', this is where
all makefiles / project files should be located.



2.	The Debugger
============================

A build including the debugger is activated by defining 'NEOPOP_DEBUG'
globally. In the Windows port this is done using the project settings,
but GCC can use the -D command line option (IIRC).

I don't expect many people to bother porting the Windows debugger -
it would require a complete re-write. I'm not sure this is to anyone's
advantage because I don't believe there are many people that use it...
I may be wrong.

I have tried to make it as easy as possible to remove the debugger
from the code base - simply remove the Debugger folder. 
The "#define NEOPOP_DEBUG" will prevent any debugging code from being
compiled.



3.	ZIP Support
============================

ZIP support (provided by zLIB 1.1.4) can optionally be omitted by changing
a #define in 'system_rom.h' and removing the 'zLIB' folder.

