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

morbus iff’s picture

morbus iff
they/them
commented

I 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.

morbus iff’s picture

morbus iff
they/them
commented

s/README.txt/INSTALL.txt/g

Barry Madore’s picture

Barry Madore commented
Component: Developer Guide » New documentation

changing component

stella’s picture

stella commented

+1 for the casetracker style

dman’s picture

dman commented

We can close this old initiative then? and throw a template up over here?

looks like I never finished that idea

morbus iff’s picture

morbus iff
they/them
commented

Moved to CSPO: http://groups.drupal.org/node/14523

sun’s picture

sun
Primary language German
Location Karlsruhe
commented

subscribing

MGParisi’s picture

MGParisi commented
Version: » 6.x-1.x-dev
Status: Active » Needs work

Why 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.

MGParisi’s picture

MGParisi commented
Assigned: Unassigned » MGParisi
Status: Needs work » Fixed

Added 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.

Status: Fixed » Closed (fixed)

Automatically closed -- issue fixed for 2 weeks with no activity.

voxpelli’s picture

voxpelli commented
Version: 6.x-1.x-dev »

Posted a follow up here: #748694: Unify documentation of best practises regarding README:s etc.