1 of 9

Slide Notes

DownloadGo Live

Please Write A README

Published on Nov 21, 2015

No Description

View Outline

MORE DECKS TO EXPLORE

PRESENTATION OUTLINE

1.

PLEASE WRITE A README

STEPHANIE HEKKER
Photo by atxryan
2.

WHAT IS A README?

...AND WHY SHOULD YOU CARE?
Photo by Yanily66
3.

PEOPLE READ THEM!

Photo by bump
4.

TIPS TO MAKE YOUR README

...ACTUALLY USEFUL
Photo by Kuba Bożanowski
5.

KEEP IT SHORT

Photo by John Steven Fernandez
6.

ADD VISUALS

Photo by kevin dooley
7.

OPTIONAL ADDITIONS

Photo by DaveFayram
8.

GITHUB EXAMPLES

Photo by Gregory Han
9.

WHEN IN DOUBT, USE A TEMPLATE!

HTTP://GITHUB.COM/STEPHZILLA/README
Photo by © 2006-2013 Pink Sherbet Photography

Stephanie Hekker

http://www.stephaniehekker.com