grease 0.3

License

Grease is distributed under a permissive MIT-style open source license. This license permits you to use grease for commercial or non-commercial purposes free of charge. It makes no demands on how, or whether, you license, or release the code derived from or built upon Grease, other than preservation of copyright notice.

For a complete text of the license see the LICENSE.txt file in the source distrbution.

Requirements

Grease is platform-independent and should run on any operating system supporting Python and Pyglet.

The following are required to build and install Grease:

• Python 2.6 (http://www.python.org/)

• Pyglet 1.1 (http://www.pyglet.org/)

Downloading Grease

You can download Grease from the python package index (pypi):

• http://pypi.python.org/pypi/grease/

You can also clone the github repository to get the very latest code:

git clone git@github.com:caseman/grease.git

Although there is no guarantee that the latest master branch code will work perfectly, or even make it to release, efforts are made to ensure Grease is functional at each push.

Installation

To install Grease from the source distribution or repository use:

python2.6 setup.py install

Once installed you can try it out by running the unit tests and the included example game, but make sure you leave the grease source directory first or they will not work properly:

cd
python2.6 -m grease.test.run_all
python2.6 -m grease.examples.blasteroids3

Note on some platforms, such as MacOS X, you will need to use pythonw2.6 to run the tests and example game.

Note, you can also try out Grease without installing it by setting your PYTHONPATH to the source directory:

export PYTHONPATH=`pwd`
python2.6 test/run_all.py
python2.6 examples/blasteroids3.py

Documentation

You can browse the documentation online at:

• http://packages.python.org/grease/

The documentation is also available for offline viewing in the doc/build/html subdirectory for the source distribution.

Development Status

Grease is alpha software under active development. The APIs may change in future releases, however efforts will be made to minimize breakage between releases.

Contributing and Getting Support

Come visit us at the Grease users google group to get help, moral support, lavish praise, complain bitterly, report a bug, or contribute ideas:

• http://groups.google.com/group/grease-users

If you would like to contribute to Grease, feel free to fork the git repository and make a pull request to have your changes reviewed. Note that bug fixes must be accompanied by unit tests, and features must also be documented. I am happy to help with these tasks if I can, so don’t be afraid to ask!