Resources for Writing Great READMEs

Check out some of these resources our instructors recommend:

• Having trouble figuring out how to outline your README? Check out this template or this template
• BE Mod 2 Lesson on Writing a great README
• Thoughtbot Blog Post: How to Write a Great README
• Dan Bader: How to Write a Great Readme for Your GitHub Project. Note: you may have to click x on the ad to get to the page
• TPW’s README-Driven-Development
• Ponyfoo on README Driven Development
• Jesse Luoto’s How to Write a good README and Why You Should Care