README Tips

Tips to help you create better, more useful README files for GitHub and elsewhere

View as source code: https://github.com/readmeTips/readmeTips.github.io

View as web page: https://readmeTips.github.io

Links to helpful pages about README files

Wikipedia README

• Includes the history of the README

Tom Preston-Werner Readme Driven Development
- One of the founders of GitHub

Stephen Whitmore Art of README

Patrick Balestra How to Improve Your GitHub README

• Some good technical tips

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 README.md

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

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

Markdown Cheat Sheets

John Gruber Daring Fireball: Markdown Basics

• The creator of Markdown

GitHub Mastering Markdown