README for planes
=================

About
-----

planes is a hierarchical surface framework for PyGame, extending it
with a hierarchy of mouse-sensitive, draggable Surfaces that can be
used as sprites, windows, icons or other interactive elements.

In addition, the planes.gui module provides basic GUI elements like
container, label, text box, option list and button.

planes is quite powerful, but sadly lacks a tutorial to get started.
This will be added in the beta (0.9.x) releases.

Prerequisites
-------------

Python >= 2.6      http://www.python.org

PyGame >= 1.9.1    http://pygame.org/


Installation
------------

Unzip the file, then at the command line run

    python setup.py install


Examples
--------

A showcase python script will be installed along with planes. Run

    planes_interactive.py


Documentation
-------------

API documentation is included and will be installed during install.


Links
-----

planes on Launchpad: https://launchpad.net/planes

planes on Freecode: http://freecode.com/projects/planes

planes on ohloh: https://www.ohloh.net/p/planes

planes on the Python Package Index: http://pypi.python.org/pypi/planes

planes on pygame.org: http://pygame.org/project-planes-2392-4051.html


Author
------

(c) Florian Berger <fberger@florian-berger.de>