===============================================
How to make your project PyCommunity-compatible
===============================================

There are a few mandatory files PyCommunity uses to generate a website:

- a `glossary.txt` file. Learn how to write a good glossary in the {{recipe:glossary_recipe}}

- a global `README.txt` file, that describes the project. {{recipe:main_readme_recipe}} gives a few tips about it

- a `package.txt` file, that is used in the package list page. This file contains a introductary text that describes the packages.

All of this files are pointed in `pycommunity.conf` and the
website is generated with this simple command. The simplest way to start is 
to copy the original `pycommunity.conf` to a specific project conf file, then
to call it::

    pycommunity /path/to/project.conf