Developers love to share code in the form of packages, full apps, or tiny modules. Sharing is great, but one area that a lot of developers forget about is the readme file. This file is now arguably one of the most important pieces for your project and one that a lot of users don’t spend any time on.
When looking for an existing open source project to solve a problem you had, you've probably asked yourself one or more of the following questions:
- Will it solve my problem?
- Can I trust this code?
- Can I trust the team/developer who created it?
- Will I be able to get help if I'm stuck?
- Are issues or pull requests dealt with?
- Am I willing to keep this updated if the project dies?
- Can I build this easier myself?
This simple application assists you in writing a readme for your own projects in a way that guides you to answering these questions.
- Check out Eric L Barnes' article on how to write a README that rocks for the inspiration behind this generator.
- I published Building a README generator with Vue.js on .dev, which talks about how this application was built.