ofxAddon
An openFrameworks addon template.
ofxAddon

Description

An addon template for openFrameworks.

Features

  • An important feature.

Getting Started

Bootstrap

Every effort is made to keep the repository small. Thus sometimes third-party libraries need to be compiled and example data needs to be downloaded. The bootstrap script takes care of this.

  • From the scripts/ directory ...
    • ./bootstrap.sh

Generate Project Files

  1. Generate the example project files using the openFrameworks Project Generator.
  2. Open the Project Files in your Integrated Development Environment (IDE), or run make && make run from the example directory.

For more, see the Getting Started guide.

Support

See the Support guide.

Documentation

API documentation can be found here.

Requirements

  • A list of any requirements, additional addons, etc.

Compatibility

Supported Platforms

Platform Stable Branch Master Branch Develop Branch Notes
osx Build Status Build Status Build Status None
linux None
linux64 Build Status Build Status Build Status None
linuxarmv6l None
linuxarmv7l None
msys2 None
vs None
ios None
tvos None
emscripten None
android None
Status Symbol
Tested
Untested ⚠️
Incompatible
Unknown

Build Status

Linux, macOS

Visual Studio, MSYS2 Build status

Branches

The stable branch of this repository is meant to be compatible with the openFrameworks stable branch, which corresponds to the latest official openFrameworks release.

The master branch of this repository is meant to be compatible with the openFrameworks master branch. This is often the same as the stable branch.

The develop branch of this repository is used by developers to test new features. It is usually compatible with the openFrameworks master branch, but is compatibility is not guaranteed. The develop branch should not be used for production.

Some past openFrameworks releases are supported via tagged versions and releases, but only stable and master branches are actively supported.

Versioning

This project uses Semantic Versioning, although strict adherence will only come into effect at version 1.0.0.

Changelog

See the Changelog.

Code of Conduct

See the Code of Conduct.

Contributing

See Contributing guide.

Licensing

See the License.