ofxAddonTemplate

OpenFrameworks addon template for easier development of structurally correct addons.

This template aids you as an addon author in creating an addon in a "proper" way. Doing this enables the openFrameworks community to easily use your addon, and having addons adhere to an established structure makes it easier for the openFrameworks developers to create features around contributed addons, like the addons index at ofxaddons.com.

Download

The template contains all you need to start developing your addon. Download the template using the Download button on the right side of the github page. Unzip, rename and copy it to your addons folder. PLEASE DON'T FORK the addon template repo if you plan on creating your own addon, this will lead to confusion on the Github inheritance/forking graph, and you will unnecessarily have this repository's history in your own git repo.

Further Steps

README_AUTHOR.md contains instructions and explanations for you. README_DEPLOY.md is filled with a template for an informative README file you might want to use with your addon.

Before announcing your addon to the world, you should remove this file (README.md) and the author instructions, and rename README_DEPLOY.md to README.md. Also, if you have special instructions which people should see when submitting a pull request or open an issue in your addon repository, add a CONTRIBUTING.md file at the root of your repository. For more details, see https://github.com/blog/1184-contributing-guidelines

This template reflects the help text found at http://ofxaddons.com/howto, and will be updated from time to time by the OF developers.

Thanks for listening, and happy coding!