diff options
| author | David Robillard <d@drobilla.net> | 2023-08-23 16:14:49 -0400 |
|---|---|---|
| committer | David Robillard <d@drobilla.net> | 2023-08-23 17:58:46 -0400 |
| commit | 36cd543badf1277039af83c8fe8b5bfa2a86280d (patch) | |
| tree | 6c78b6e55e56a3ad6b6fa3f4a20e3808ad8eb682 /README.md | |
| parent | cfb97d0865e235458b186cc21cafe4367bce72f4 (diff) | |
| download | zix-36cd543badf1277039af83c8fe8b5bfa2a86280d.tar.gz zix-36cd543badf1277039af83c8fe8b5bfa2a86280d.tar.bz2 zix-36cd543badf1277039af83c8fe8b5bfa2a86280d.zip | |
Clean up and update documentation
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 32 |
1 files changed, 25 insertions, 7 deletions
@@ -6,16 +6,29 @@ Zix is a lightweight C library of portability wrappers and data structures. Components ---------- +* Allocation + * `ZixAllocator`: A customizable allocator. * `ZixBumpAllocator`: A simple realtime-safe "bump-pointer" allocator. + +* Algorithms + + * `zix/digest.h`: Digest functions suitable for hashing arbitrary data. + +* Data Structures + * `ZixBTree`: A page-allocated B-tree. * `ZixHash`: An open-addressing hash table. * `ZixRing`: A lock-free realtime-safe ring buffer. + * `ZixTree`: A binary search tree. + +* Threading + * `ZixSem`: A portable semaphore wrapper. * `ZixThread`: A portable thread wrapper. - * `ZixTree`: A binary search tree. - * `zix/digest.h`: Digest functions suitable for hashing arbitrary data. +* File System + * `zix/filesystem.h`: Functions for working with filesystems. * `zix/path.h`: Functions for working with filesystem paths lexically. @@ -24,15 +37,19 @@ Platforms Zix is continually tested on: - * GNU/Linux (x86, arm32, and arm64) - * FreeBSD (x64) - * MacOS (x64) - * Node (as wasm via emscripten) + * Debian GNU/Linux 11 (x86, x64, arm32, and arm64) + * Fedora 36 (x64) + * FreeBSD 13.2 (x64) + * MacOS 11.7 (x64) + * Node 12 (as wasm via emscripten) + * Windows 10 (x86) Dependencies ------------ -None, except the C standard library. +None, +except the C standard library, +and some POSIX and platform-specific APIs where necessary. Documentation ------------- @@ -40,5 +57,6 @@ Documentation * [Installation Instructions](INSTALL.md) * [API reference (single page)](https://drobilla.gitlab.io/zix/doc/singlehtml/) * [API reference (paginated)](https://drobilla.gitlab.io/zix/doc/html/) + * [Test Coverage](https://drobilla.gitlab.io/zix/coverage/) -- David Robillard <d@drobilla.net> |