File Structure

This project will be using a fairly simple file structure. It looks like this:

/
The root directory, contains the following:

README
     A general README file describing the project and where to look for build instructions and documentation and where the website is.

INSTALL
    Instructions for building and installing the project

LICENSE
    Will contain the full text of the license this code will be distributed under (GPL2)

Makefile
    Makefile for the entire project. Currently only generates the doxygen docs.

doxyconf.cfg
    This is the configuration file for the doxygen documentation.

/data
    Example/Library scripts, image files, and other resources will go here. Currently empty.

/docs
    A subdirectory containing some documentation for the project. Currently empty, as most of the documentation is under the www folder

/proj
    Project files for various IDE's will be placed here. These are provided as a convenience and are not garaunteed to be up-to-date at any given time. If they are not, use the main build system (currently through makefiles).

/src
    This is where all the source files will go. It will also contain subdirectories for each module.

/backend
    This is for the abstraction layers between the engine and external libraries, such as Ogre, OpenGL, etc..

/engine
    For the main engine objects, such as Entity, Behavior, etc..

/interface
    The IDE and other UI-related code is here.

/main
    Main program sources go here. For example: testmain.cpp and main.cpp

/util
    Project-wide utilities such as Error and MathUtils.h go here.

/tools
Various tools and utilities related to the project. Currently contains some unit testing scripts and xcode template files for doxygen.

/www
This is where the web pages will be stored. The doxygen generated documentation files will NOT be placed in the CVS repository, but will be generated and uploaded manually.