Developer Guide

1. About this Guide
2. Introduction
3. Contributing
4. Build
5. Directory Layout
6. Further Reading...

About this Guide

This Developer's Guide is intended to assist developers who wish to contribute to gfw development. If you have any suggestions or comments please feel free to forward them to me .

Build

gfw uses Maven to automatically account for project dependencies, and generate project documentation from XHTML (including the HTML you're reading now). See the Maven site, and the project.xml and build.xml files in our repository for more information.

Directory Layout

All projects built on the common framework conform to a common directory layout. This layout is modeled after Maven's suggested project layout. Refer to Maven for more information and examples.

The web application directories and other plugin specific information is placed under src

src
+---java
    +---net
        \---mlw
            \---gfw
                +---client     (Common client code)
                +---event      (Common event code)
                \---server     (Common server code)