I like the idea of README.md Also it will be useful to have those for modules...
--- Regards, Saptarshi PURKAYASTHA My Tech Blog: http://sunnytalkstech.blogspot.com You Live by CHOICE, Not by CHANCE On 18 May 2012 20:29, Burke Mamlin <[email protected]> wrote: > Devs, > > Could we migrate toward a convention of using a README file at the root of > each module? I know there's a place for a description in the config.xml, > but it's not very friendly when trying to scan through > modules<http://svn.openmrs.org/openmrs-modules/>and understand their purpose. > And I'm sure an improved module repository > will help some day, but not all modules make it into the module repository. > > For example, adopt a convention of placing a README (e.g., one of README, > README.txt, README.md) containing a description of the module in the root > of each module's tree (or in trunk/ if the module uses the trunk/, > branches/, tags/ folder convention). This is already a prevailing > convention in open source coding, right? > > OpenMRS has a "readme.txt" file in trunk. We could use the same for > contribs. > > Thoughts? > > -Burke > _________________________________________ To unsubscribe from OpenMRS Developers' mailing list, send an e-mail to [email protected] with "SIGNOFF openmrs-devel-l" in the body (not the subject) of your e-mail. [mailto:[email protected]?body=SIGNOFF%20openmrs-devel-l]
