diff options
| author | David Robillard <d@drobilla.net> | 2021-09-18 20:35:19 -0400 |
|---|---|---|
| committer | David Robillard <d@drobilla.net> | 2021-09-18 20:38:13 -0400 |
| commit | 04039f48db7b7112169e9483839c17fc7066a5ff (patch) | |
| tree | 9719ecadd536c2cfd6c4ea40a56e18206af9dc98 | |
| parent | 012116d975ff72da6f66486aa6547e2b5ce5e991 (diff) | |
| download | zix-04039f48db7b7112169e9483839c17fc7066a5ff.tar.gz zix-04039f48db7b7112169e9483839c17fc7066a5ff.tar.bz2 zix-04039f48db7b7112169e9483839c17fc7066a5ff.zip | |
Update README
| -rw-r--r-- | README.md | 36 |
1 files changed, 33 insertions, 3 deletions
@@ -1,8 +1,38 @@ Zix === -Zix is a lightweight C library of portability wrappers and data structures. It -can be used as a header-only library and incorporated piecemeal into projects, -or built and installed as a normal shared or static library. +Zix is a lightweight C library of portability wrappers and data structures. + +Dependencies +------------ + +None, except the C standard library. + +Building +-------- + +Zix is a straightforward collection of C headers and implementation files which +should be easy to build or incorporate into a project. + +A [Meson][] build definition is included which can be used to do a proper +system installation with a `pkg-config` file, generate IDE projects, run the +tests, and so on. For example, the library and tests can be built and run like +so: + + meson setup build + cd build + ninja test + +See the [Meson documentation][] for more details on using Meson. + +Usage +----- + +The [headers](include/zix/) are reasonably well documented. There is no +external documentation at this time. -- David Robillard <d@drobilla.net> + +[Meson]: https://mesonbuild.com/ + +[Meson documentation]: https://mesonbuild.com/Quick-guide.html |