README files

IMPORTANT: This is a work in progress. Discussion happens in http://groups.drupal.org/node/14523

The only current standard for contributed code is to place a README.txt with in the package. Often times additional documentation can be placed within an INSTALL.txt.

Some nicer README.txt files can be found here:

Morbus' style (which matches Drupal core's style):
http://cvs.drupal.org/viewvc.py/drupal/contributions/modules/bot/README....

sun style:
http://cvs.drupal.org/viewvc.py/drupal/contributions/modules/admin_menu/...

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

 
 

Drupal is a registered trademark of Dries Buytaert.