Welcome! Thank you for considering the README file.

Contents

1. What is ringbuffer?
2. Why using ringbuffer?
3. License
4. Documentation
5. Installation & Debugging
6. Examples
7. Thanks to
8. Contact

`ringbuffer' is a simple library containing a ringbuffer.

The ringbuffer is lock-free (using atomics only), and allows multiple readers, but only one writer.

The ringbuffer is real-time safe, i.e. guarantees that the functions return "fast enough" (except to initialization and cleanup routines).

Parts of the code have their origin in JACK's ringbuffer.

As mentioned, the advantages are:

• minimality
• no dependencies
• lock-freeness while still supporting multiple readers
• real-time safety
• safety (tests are included)

Please see the LICENSE file.

See the DOCUMENTATION for official docs.

Type make doc for doxygen.

Please see the INSTALL file.

See tests.

In alphabetical order, I thank:

• Martin Pavelek (@he29-net)
• The JACK team for their ringbuffer

Feel free to give feedback on github.