From 57164aba14c157288df338b8cf2f5622d01ff460 Mon Sep 17 00:00:00 2001 From: Matt Strapp Date: Tue, 14 May 2024 16:16:31 -0500 Subject: Add a half-assed doxygen implementation and start a really bad idea Signed-off-by: Matt Strapp --- docs/C.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 docs/C.md (limited to 'docs') diff --git a/docs/C.md b/docs/C.md new file mode 100644 index 0000000..c5e2094 --- /dev/null +++ b/docs/C.md @@ -0,0 +1,43 @@ +# liboCusts + +## Description +liboCusts is a library that provides a way to introduce locusts into your code. + +Why would you want to do that? I don't know. + +## Example +```c +#include "locusts.h" +int main(void) { + introduce_locusts(); + /* Locusts are now in your codebase! */ + return 0; +} +``` + +## Building +Multiple build systems are supported. + +### Meson +```sh +meson setup builddir --buildtype=release +meson compile -C builddir +``` + +### CMake +```sh +cmake -S . -B build +cmake --build build +``` + +### Autoconf +```sh +autoreconf -fi +./configure +make +``` + + +## License +This project is licensed under the BSD Zero Clause License. See the [LICENSE](LICENSE) file for details. +``` -- cgit v1.2.3