********************************************************************************
*                                                                              *
*                                 Athena-Core                                  *
*                                Version 1.3.3                                 *
*                       http://github.com/Kanma/Athena-Core                    *
*                                                                              *
********************************************************************************


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

Athena-Core is the base module of the Athena Game Framework, in the form
of a library written in C++.

The classes contained in that module are used by nearly all the other modules.

This module can be used as a standalone library, or combined with the rest of
the Athena Game Framework (http://github.com/Kanma/Athena-Framework).

Additionally, when the Athena-Scripting (http://github.com/Kanma/Athena-Scripting)
module is built alongside this one, Athena-Core will be usable from JavaScript.


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

Athena-Core requires the following dependencies:

   - XMake
   - Athena-Math
   - UnitTest++
   - rapidjson

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

To download them, do:

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


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

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

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

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

The library will be put in build/bin/


---------------------------------------
- Credits
---------------------------------------

Some classes of this module are based on the corresponding classes of OGRE 1.7
(Object-Oriented Graphics Rendering Engine), a scene-oriented and flexible 3D
engine, released under the MIT License. OGRE is the 3D engine used by the Athena
Game Framework.

The license of OGRE is contained in the file 'docs/LICENSE-OGRE'.


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

Athena-Core 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-Core 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.