On Wed, 10 Feb 2010 17:10:02 +0100 Florian Desbois <fdesbois@codelutin.com> wrote:
Bonjour à tous,
Je me demandais s'il serait pas intéressant d'utiliser le README.txt comme référence d'installation de l'application, et dans ce cas à l'instar du changelog.txt (pour le labs) faire une copie automatique du README qui serait au format rst, dans le site maven génerer sous la forme install.rst.
Après discussion avec Tony, le README.txt ne semble pas fait pour ca, il serait donc préférable d'avoir obligatoirement un install.txt qui pourrait fournir ce service :
- Comment installer l'application (mode serveur/ mode stand-alone) - Comment gérer la dépendance pour le cas d'une lib
Une question se pose alors, que faut-il mettre dans le README.txt si ce n'est pas comment installer l'application ?
Qu'en pensez-vous ?
Dans le README.txt, tu expliques ou trouver la documentation (dans site/rst) et comment compiler le programme (mvn). Tu peux aussi rappeler le copyright et la licence. Et surtout tu mets les moyens de contact (mail, list, ou l'endroit ou les trouver) en gros toutes les explications de la au trouver les informations :) donc tu peux aussi explique l'arbo du projet (src/main/java, src/site, ...) -- Benjamin -------------------- tél: +33 (0) 2 40 50 29 28 email: poussin@codelutin.com () campagne du ruban ascii http://www.codelutin.com /\ pour les mails en ascii