We should brainstorm a nice template for README.txt and encourage contributed module authors to use it.
Some nicer README.txts I've seen, as I was desperately searching for this when I first started in the Drupal community:
Morbus style:
http://cvs.drupal.org/viewvc.py/drupal/contributions/modules/casetracker...
John VanDyke/Matt Westgate style:
http://cvs.drupal.org/viewvc.py/drupal/contributions/modules/actions/REA...
syscrusher style:
http://cvs.drupal.org/viewvc.py/drupal/contributions/modules/links/READM...
Other recommendations?
I like Morbus's style, personally. Discuss.
Comments
s/README.txt/INSTALL.txt/g
Comment #3
Barry Madore commentedchanging component
Comment #5
dman commentedWe can close this old initiative then? and throw a template up over here?
Moved to CSPO: http://groups.drupal.org/node/14523
subscribing
Comment #8
MGParisi commentedWhy don't you make a simple page with the references above.
In a perfect world It would be nice to have everyone follow a README standard, but I personally think a recommendations and examples are a better solution.
Comment #9
MGParisi commentedAdded http://drupal.org/node/447604
Not perfect, needs work... but definitely a nice start to help people.
Will mark as fixed... Feel free to edit, add and change the document.
Automatically closed -- issue fixed for 2 weeks with no activity.
Comment #11
voxpelli commentedPosted a follow up here: #748694: Unify documentation of best practises regarding README:s etc.
Comment #1
morbus iffI really think this is the wrong question. We have a style: core's README.txt. Use core's style, or be wrong.
Note: I have no style. My documentation is, yup, core's style.