When creating an open source project on GitHub, it’s important to have a high-quality README for the app. This should include what the app is for, how to use the app, how to install it, how to report issues, and how to make contributions—this last part increases the likelihood that other developers will contribute to the success of the project.

This command line program allows you to quickly and easily create a README file.

I first enter my project title this is displayed as the title of the README I enter a description, installation instructions, usage information, contribution guidelines, and test instructions this information is added to the sections of the README entitled Description, Installation, Usage, Contributing, and Tests I choose a license for my application from a list of options a badge for that license is added near the top of the README and a notice is added to the section of the README entitled License that explains which license the application is covered under I enter my GitHub username this is added to the section of the README entitled Questions, with a link to my GitHub profile I enter my email address this is added to the section of the README entitled Questions, with instructions on how to reach me with additional questions I click on the links in the Table of Contents I am taken to the corresponding section of the README

see demo

example of generated readme