tnick / april Goto Github PK

Introduction
===========================

The April project[2] defines a set of C++ objects (World, Actor, Sensor, Reflex,
Brain, Actuator, Event) that help simulate various environments.

The world has an amount of energy that the user may use to create Actors and
components while Actors may also create other Actors from their own energy.

The code is structured in several layers:
- april-core simply defines the library and the objects
- april-gui builds on the concepts in april-core, giving a visual
interpretation to the concepts
- AprilDream is a GUI program that uses april-gui objects to display a World in
evolution.

The code base also contains a test suite based on Google test and a set of
ever-growing commented examples.


Getting the package
===========================

The binary packages are available at sourceforge[3].
The project uses Git as version control system. To clone the repository
use:

git clone git://git.code.sf.net/p/aprilproject/code aprilproject-code


Licence
===========================

The project is distributed under the 3-clause license
("Revised BSD License", "New BSD License", or 
"Modified BSD License") [1]. Read about it in the COPYING file.


Instalation
===========================

To build and install the library follow the instructions in INSTALL file.


Content of the package
===========================

april (directory)
    groups the C++ source files and headers
debian (directory)
    contains the files that are used to generate debian distributions.build (directory)
    by default the result of the building process are placed 
    in this directory. It is not part of the source distribution.
distrib (directory)
    this is where the distributions are generated. It is not part of the source
    distribution.
tools (directory)
    various helper files


[1] http://en.wikipedia.org/wiki/BSD_licenses#3-clause_license_.28.22Revised_BSD_License.22.2C_.22New_BSD_License.22.2C_or_.22Modified_BSD_License.22.29
[2] http://aprilproject.sourceforge.net/
[3] http://sourceforge.net/projects/aprilproject/files/