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


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

Athena-Inputs is one of the modules of the Athena Game Framework, in the form
of a library written in C++.

This module is used to read user's commands, via the keyboard, mouse and
gamepads.


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).


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

Athena-Inputs requires the following dependencies:

   - XMake
   - Athena-Math
   - Athena-Core
   - UnitTest++
   - rapidjson
   - OIS

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

To download them, do:

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


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

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

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

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

The library will be put in build/bin/


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

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