Skip to content

Instantly share code, notes, and snippets.

@golanlevin

golanlevin/template_README.md

Last active February 18, 2016 22:29
Show Gist options
  • Save golanlevin/c5f5733b8ecb23c21427 to your computer and use it in GitHub Desktop.
Save golanlevin/c5f5733b8ecb23c21427 to your computer and use it in GitHub Desktop.
Download ZIP
Template for openFrameworks Example README.md files.
Raw
template_README.md

#About exampleName

###Learning Objectives

This openFrameworks Example is designed to demonstrate ...

  • How to ...
  • The ability of openFrameworks to ...

{Guide the reader to what's important in the code of the App.}

Expected Behavior

When launching this app, you should see a screen with...

Instructions for use:

  • Try moving your cursor left-right in order to....
  • Press to clear...

{If there are a lot of key commands, it's not necessarily appropriate here to give detailed instructions about what every keypress does. The In-app Overlays should accomplish that. It may be enough to say something like, "Keypresses allow the user to select among various different effects."}

Screenshot of Example, stored as exampleName/screenshot.png (or .gif or .jpg)

###Other classes used in this file

This Example uses the following classes:

  • OtherClass1
  • OtherClass2
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment