Skip to content

Latest commit

 

History

History
122 lines (80 loc) · 4.91 KB

README.md

File metadata and controls

122 lines (80 loc) · 4.91 KB
Raw

ofxIO

Description

A collection of I/O core utils for openFrameworks.

Features

  • ofEvent-based Directory Watcher
    • Watch for changes in your directories.
    • NOTE: Poco::DirectoryWatcher was added in Poco 1.5+. These files are included for backward compatibility.
  • File filters.
  • Compression
    • Zip, deflate, gzip, snappy, LZ4, brotli
    • Encoding.
      • COBS, SLIP, Hex Binary, Base64, etc.
  • ByteBuffer
    • Tools for interacting with raw byte buffers.
    • ByteBuffer streams.
    • ByteBufferReader.
    • ByteBufferWriter.
    • ByteBufferStream.
  • Recursive File Listing Poco::RecursiveDirectoryIterator
    • List files and folders inside of directories.
    • Use custom file filters to return relevant results.
      • NOTE: Poco::RecursiveDirectoryIterator was added in Poco 1.6+. These files are included under the ofxIO namespace for backward compatibility.
  • Correct alphanumeric filename ordering

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 docs/GETTING_STARTED.md.

Support

See docs/SUPPORT.md.

Documentation

API documentation can be found here.

Requirements

  • ofxPoco (included with openFrameworks)

Compatibility

Supported Platforms

Platform Build Status Notes
osx ❓ None
linux ❓ None
Linux64 ❓ None
linuxarmv6l ❓ None
msys2 ❓ None
vs ❓ None
ios ❓ None
tvos ❓ None
emscripten ❓ None
android ❓ None
Status Symbol
Tested ✅
Untested ⚠️
Incompatible ❌
Unknown ❓

Linux, macOS Build Status

Visual Studio, MSYS Build status

Build Status

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.

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

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 CHANGELOG.md

Code of Conduct

See CODE_OF_CONDUCT.md

Contributing

See CONTRIBUTING.md

Licensing

See LICENSE.md