README.rst template for Github projects

gistfile1.rst

project-name

project-name aims at... (goals, comparison with others on the market)

Features:

• 1
• 2
• 3

Contributions and comments are welcome using Github at: http://github.com/centralniak/project-name

Please note that project-name requires:

• package-a >= 1.2.3
• package-b

Installation

1. pip install project-name
2. Add 'project_name.middleware.ProjectNameMiddleware' to MIDDLEWARE_CLASSES (if necessary)
3. Add 'project_name' to INSTALLED_APPS (if necessary)
4. Run syncdb (if necessary)

Configuration

Necessary settings, cache requirements, etc.

Documentation

RTFD link if existent

Usage

Only if no RTFD documentation supplied

Bugs & Contribution

Please use Github to report bugs, feature requests and submit your code: http://github.com/centralniak/project-name

author:	Piotr Kilczuk
date:	2011/01/01