********************************************************************************
*                                                                              *
*                               Athena-Framework                               *
*                                Version 1.0.1                                 *
*                    http://github.com/Kanma/Athena-Framework                  *
*                                                                              *
********************************************************************************


---------------------------------------
- Summary
---------------------------------------

The Athena Game Framework, which glue together all the modules and add some
game-related systems (Tasks, Game States).


---------------------------------------
- Dependencies
---------------------------------------

Athena-Framework requires the following dependencies:

   - XMake
   - Athena-Math
   - Athena-Core
   - Athena-Entities
   - Athena-Graphics
   - Athena-Physics
   - Athena-Inputs
   - FreeImage
   - freetype
   - Ogre
   - OIS
   - Bullet
   - rapidjson
   - UnitTest++
   - zlib
   - zziplib

They are provided as GIT submodules of this repository and will be compiled
automatically during the compilation of Athena-Framework.

To download them, do:

    somewhere$ cd <path/to/the/source/of/Athena-Framework>
    Athena-Framework$ git submodule init
    Athena-Framework$ git submodule update


---------------------------------------
- Compilation
---------------------------------------

(Note: you'll need to install CMake to compile Athena-Framework)

To compile Athena-Framework (and all its dependencies), do:

    somewhere$ mkdir build
    somewhere$ cd build
    build$ cmake <path/to/the/source/of/Athena-Framework>
    build$ make

The library will be put in build/bin/


---------------------------------------
- License
---------------------------------------

Athena-Framework is is made available under the MIT License. The text of the license
is in the file 'LICENSE'.

Under the MIT License you may use Athena-Framework for any purpose you wish, without
warranty, and modify it if you require, subject to one condition:

   "The above copyright notice and this permission notice shall be included in
   all copies or substantial portions of the Software."

In practice this means that whenever you distribute your application, whether as
binary or as source code, you must include somewhere in your distribution the
text in the file 'LICENSE'. This might be in the printed documentation, as a
file on delivered media, or even on the credits / acknowledgements of the
runtime application itself; any of those would satisfy the requirement.

Even if the license doesn't require it, please consider to contribute your
modifications back to the community.