root / pycommunity / pycommunity / doc / recipes / main_readme_recipe.txt
| Revision 68:83208f451b91, 205 bytes (checked in by Tarek Ziad?? <tarek@…>, 18 months ago) |
|---|
| Line | |
|---|---|
| 1 | How to write the main README |
| 2 | ============================ |
| 3 | |
| 4 | The main README file should: |
| 5 | |
| 6 | - summarize what the project does |
| 7 | |
| 8 | - provide an overview of the architecture |
| 9 | |
| 10 | - provide links to online ressources |
Note: See TracBrowser
for help on using the browser.
