diff options
| author | David Robillard <d@drobilla.net> | 2022-06-29 09:30:06 -0400 |
|---|---|---|
| committer | David Robillard <d@drobilla.net> | 2022-07-20 16:24:23 -0400 |
| commit | d3bb4e9c2dba3cebfa7ce9f37d32e54ec2fe14a3 (patch) | |
| tree | 4d97d8e683262f69e813dfbbd1924e1a9e4c68a3 /README.md | |
| parent | 7f4f065c64ab99c63f4e86d5b3310098c5b4f2f1 (diff) | |
| download | raul-d3bb4e9c2dba3cebfa7ce9f37d32e54ec2fe14a3.tar.gz raul-d3bb4e9c2dba3cebfa7ce9f37d32e54ec2fe14a3.tar.bz2 raul-d3bb4e9c2dba3cebfa7ce9f37d32e54ec2fe14a3.zip | |
Adopt REUSE machine-readable licensing standard
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..ceb0127 --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +Raul +==== + +Raul (Realtime Audio Utility Library) is a header-only C++ utility library for +real-time audio applications. + +Components +---------- + + * `Array`: A disposable array with a runtime size. + * `DoubleBuffer`: A realtime-safe double buffer. + * `Maid`: A simple explicit garbage collector. + * `Path`: A restricted path of symbols. + * `Process`: A child process. + * `RingBuffer`: A lock-free ring buffer. + * `Semaphore`: A process-local counting semaphore. + * `Socket`: A UNIX or TCP socket. + * `Symbol`: A valid C identifier string and path component. + +Dependencies +------------ + +None, except the C++ standard library. + +Documentation +------------- + +Public interfaces are well-documented in the [headers](include/raul/). There +is no external documentation at this time. + + * [Installation Instructions](INSTALL.md) + + -- David Robillard <d@drobilla.net> |