Make a README

Make a README explains what a README is, what the benefits are, and what makes for a good README. It also provides an editable template, with live Markdown rendering.

I hope people who are new to programming will find it useful, but even for more experienced programmers, I think it's worth evaluating once in a while if we are doing a good job when it comes to the small details that can matter more than we might think.

Make a README is inspired by Keep a Changelog.

Related Resources

• Art of README
• Awesome README
• Standard Readme

Roadmap

• Translate the website
• Create an interactive README generator (#15)
• Link to great examples (#14)
• check and improve accessibility

Contributing

Please feel free to submit an issue or pull request. The website is simple enough to not require a build process. Just open public/index.html in a browser.

If you want live reloading and have Node installed, run $ yarn install && yarn start. If you have Python and Docker installed, you can run $ ./dev start instead.

License

MIT