search

rcorp / standard-project-structure

A mission to improve developer productivity. Automate Everything ™ !
Apache License 2.0
5 stars 3 forks source link

Structure of Project README's #34

Open gaurav21r opened 8 years ago

gaurav21r commented 8 years ago

For a project hosted on Github, the README.md is perhaps the most important file we can have! We need to generate a template (possibly of Yeoman) which can give details of each module as well as a good scaffold for Project specifics.

gaurav21r commented 7 years ago

This seems to be an excellent resource https://github.com/noffle/art-of-readme/blob/master/README.md