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

Welcome to PSyclone. PSyclone is a code generation system that generates
appropriate code for the PSyKAl code structure developed in the GungHo project.

Please see psyclone.pdf in this directory for more information. If you would
prefer to build the documentation, please see the README file in the "doc"
directory.

There is a simple installer (contributions/install) which creates a
stand-alone tree containing the functional components. To make use of the
result add the python package directories to PYTHONPATH and consider adding
the "bin" directory to PATH.

Structure
=========

changelog      : information on changes between releases
contributions/ : Unsupported additional material
doc/           : documentation source using sphinx
examples/      : simple examples
psyclone.pdf   : generated documentation
README         : this file
README.gource  : information on how to generate a gource video from the
                 repository
README.uml     : information on how to create UML class diagrams from the source
                 using pyreverse
src/           : the python source code
src/tests/     : unit and functional tests using pytest