================================================================================
                              THE Elimu System REPOSITORY
                           Structure and build system
================================================================================

This document describes the Elimu System projects (framework library, services and clients) repository
and how to build it. For information about Elimu System as an application, you can visit
the web site http://project.coders4africa.org/

Part I. The repository layout
--------------------------------------------------------------------------------                            

Follows the file layout of the Elimu System repository. Files marked with a � are not
part of the Git repository but are either automatically generated by the
build script or user-created if needed.  This is not a complete listing.

Elimu System/    
      docs/                     Documentation and sample code.
      lib/                      Pre-compiled libraries for the build.
         
      project/                  Build or project file data
      README                    The file you are currently reading.
      src/                      All the source files of Elimu System.
          elimu-framework/               The sources of the Actor library.
          elimu-service/             The sources of the Elimu System compiler.
          elimu-ui/              The sources of the core Elimu System library.
				elimu-web/       Web applications for the elimu system
				elimu-mobile/    Mobile applications for the elimu sustem
		  
      test/                     The high level Elimu System test suite.
      tools/                    Developer utilities.

Part II. Building Elimu System 
--------------------------------------------------------------------------------

TBD

REQUIREMENTS :

  - A Java runtime environment (JRE) or SDK 1.6 or above.
  - PhpCake ?


Part III. Common use-cases
--------------------------------------------------------------------------------

TBD

Part V. Contributing to Elimu System
--------------------------------------------------------------------------------

If you wish to contribute, you can find all of the necessary information on
the official Elimu System website: project.coders4africa.org.

Specifically, you can subscribe to the Elimu System mailing lists, read all of the
available documentation, and browse the live Github repository.  You can contact
the Elimu System team by sending us a message on one of the mailing lists, or by using
the available contact form.

In detail:

- Elimu System website (links to everything else):
  http://www.coders4africa.org


- Elimu System live SVN source tree:
  https://github.com/coders4elimu/elimusys/

- Project:
  http://project.coders4africa.org


If you are interested in contributing code, we ask you to complete and submit
to us the Elimu System Contributor License Agreement, which allows us to ensure that
all code submitted to the project is unencumbered by copyrights or patents.

Thank you!
The Elimu System Team