This GitHub organization and repository has a single, simple mission: to help you create better, more useful README files for use in GitHub and elsewhere

Viewing this file

View this file as source code:

View this file as a web page using GitHub Pages:

Essential tips for a nice readme

Wikipedia README

Tom Preston-Werner Readme Driven Development

Readme file guides on GitHub:

Stephen Whitmore Art of README

Patrick Balestra How to Improve Your GitHub README

GitHub About READMEs

18F Making READMEs readable

Claire N Streb All Hail the README File!

GitHub: Open Source Guides

Richard Littauer Standard Readme

Create a home page auto-magically from

If you are a GitHub user named %username% and and create a repository at and add a file, then the README file will be auto-magically be translated into HTML and will display as HTML when you go to

This README is a good example. Go to to see the result.

Markdown cheat sheets

John Gruber Daring Fireball: Markdown Basics

GitHub Mastering Markdown