MyAddon (rename to your addon's name)

This is a template of a README file for your addon. Fill in the relevant sections, and it should already give users a pretty good overview over your awesome addon! We chose the Markdown format since it can present good formatting where available (e.g. on Github) while still staying human-readable with a plain text editor. Don't forget, before announcing your addon to the world, you should replace README.md with this file and remove README_AUTHOR.md.

Introduction

Describe what your addon is about

License

State which license you offer your addon under. openFrameworks is distributed under the MIT License, and you might consider using this for your repository. By default, license.md contains a copy of the MIT license to which you can add your name and the year.

Installation

Any steps necessary to install your addon. Optimally, this means just dropping the folder into the openFrameworks/addons/ folder.

Dependencies

What other addons are needed to properly work with this one?

Compatibility

Which versions of OF does this addon work with?

Known issues

Any specific (and long-living) issues/limitations you want to mention? For bugs, etc. you should use the issue tracker of your addon's repository

Version history

It make sense to include a version history here (newest releases first), describing new features and changes to the addon. Use git tags to mark release points in your repo, too!

Version 0.1 (Date):

Describe relevant changes etc.