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.

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

Rewrite README.md and move current content to CONTRIBUTING.md #42

Open
thundergolfer opened this issue Jul 22, 2017 · 0 comments
Open

Comments

@thundergolfer
Copy link
Contributor

A lot of the content in the README.md is intended for contributors to the project, where it is actually typical of the README.md to be something to promote and explain the project to outsiders.

So really a new CONTRIBUTING.md should be created and the content relevant to that in the README.md should be moved in.

The README.md can be left a bit empty after this, but maybe add the skeleton with sections to eventually fill. Key sections would be a section with demonstration images, a features section, and a section explaining how others can 'spin up' our project on their own machine.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant