Introducing 

Prezi AI.

Your new presentation assistant.

Refine, enhance, and tailor your content, source relevant images, and edit visuals quicker than ever before.

Loading…
Transcript

Dude, where's my README?

Exploring the subtle art of writing an effective README

Getting to know you...

Getting to know you

What is a README?

What is a README?

"A form of documentation, it is usually a simple plain text file called READ.ME, README.TXT, README.md (for a text file using markdown markup), README.1ST – or simply README."

- Wikipedia

What makes a README effective?

What makes a README

effective?

  • Keep it brief
  • Give information necessary to compile, run and test the application
  • It's not API documentation!
  • Part of your application code
  • Include common troubleshooting scenarios
  • Clearly define commands to run

Example

Example

https://gist.github.com/PurpleBooth/109311bb0361f32d87a2

Learn more about creating dynamic, engaging presentations with Prezi