Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Structure of Project README's #34

Open
gaurav21r opened this issue Sep 1, 2016 · 1 comment
Open

Structure of Project README's #34

gaurav21r opened this issue Sep 1, 2016 · 1 comment
Labels
github structure

Comments

@gaurav21r
Copy link
Member

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 gaurav21r mentioned this issue Sep 1, 2016
Open
3 tasks
@gaurav21r
Copy link
Member Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
github structure
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@gaurav21r