| Line | |
|---|
| 1 | =============================================== |
|---|
| 2 | How to make your project PyCommunity-compatible |
|---|
| 3 | =============================================== |
|---|
| 4 | |
|---|
| 5 | There are a few mandatory files PyCommunity uses to generate a website: |
|---|
| 6 | |
|---|
| 7 | - a `glossary.txt` file. Learn how to write a good glossary in the {{recipe:glossary_recipe}} |
|---|
| 8 | |
|---|
| 9 | - a global `README.txt` file, that describes the project. {{recipe:main_readme_recipe}} gives a few tips about it |
|---|
| 10 | |
|---|
| 11 | - a `package.txt` file, that is used in the package list page. This file contains a introductary text that describes the packages. |
|---|
| 12 | |
|---|
| 13 | All of this files are pointed in `pycommunity.conf` and the |
|---|
| 14 | website is generated with this simple command. The simplest way to start is |
|---|
| 15 | to copy the original `pycommunity.conf` to a specific project conf file, then |
|---|
| 16 | to call it:: |
|---|
| 17 | |
|---|
| 18 | pycommunity /path/to/project.conf |
|---|
| 19 | |
|---|
