| Line | |
|---|
| 1 | <html> |
|---|
| 2 | <head> |
|---|
| 3 | <title>How to write the main README</title> |
|---|
| 4 | <style type="text/css" media="all"> |
|---|
| 5 | @import "../pycommunity.css"; |
|---|
| 6 | </style> |
|---|
| 7 | <script language="javascript" type="text/javascript" |
|---|
| 8 | src="../pycommunity.js" ></script> |
|---|
| 9 | </head> |
|---|
| 10 | <body> |
|---|
| 11 | <div class="backlink"> |
|---|
| 12 | <a href="../recipes.html"> |
|---|
| 13 | <img src="../media/recipe.png"/> |
|---|
| 14 | Recipe list |
|---|
| 15 | </a> |
|---|
| 16 | <a href="../index.html"> |
|---|
| 17 | <img src="../media/home.png"/> |
|---|
| 18 | Main page |
|---|
| 19 | </a> |
|---|
| 20 | </div> |
|---|
| 21 | <div class="content"> |
|---|
| 22 | <div class="document" id="how-to-write-the-main-readme"> |
|---|
| 23 | <h1 class="title">How to write the main README</h1> |
|---|
| 24 | <p>The main README file should:</p> |
|---|
| 25 | <ul class="simple"> |
|---|
| 26 | <li>summarize what the project does</li> |
|---|
| 27 | <li>provide an overview of the architecture</li> |
|---|
| 28 | <li>provide links to online ressources</li> |
|---|
| 29 | </ul> |
|---|
| 30 | </div> |
|---|
| 31 | </div> |
|---|
| 32 | <div class="backlink"> |
|---|
| 33 | <a href="../recipes.html"> |
|---|
| 34 | <img src="../media/recipe.png"/> |
|---|
| 35 | Recipe list |
|---|
| 36 | </a> |
|---|
| 37 | <a href="../index.html"> |
|---|
| 38 | <img src="../media/home.png"/> |
|---|
| 39 | Main page |
|---|
| 40 | </a> |
|---|
| 41 | </div> |
|---|
| 42 | </body> |
|---|
| 43 | </html> |
|---|
