aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorMatt Strapp <matt@mattstrapp.net>2024-05-14 16:16:31 -0500
committerMatt Strapp <matt@mattstrapp.net>2024-05-14 16:16:31 -0500
commit57164aba14c157288df338b8cf2f5622d01ff460 (patch)
treea91454f6b008f26e0d5838ff3e334b7d394da356 /docs
parentAdd a C file to make C compilers actually build this into a shared object (diff)
downloadlocusts-57164aba14c157288df338b8cf2f5622d01ff460.tar
locusts-57164aba14c157288df338b8cf2f5622d01ff460.tar.gz
locusts-57164aba14c157288df338b8cf2f5622d01ff460.tar.bz2
locusts-57164aba14c157288df338b8cf2f5622d01ff460.tar.lz
locusts-57164aba14c157288df338b8cf2f5622d01ff460.tar.xz
locusts-57164aba14c157288df338b8cf2f5622d01ff460.tar.zst
locusts-57164aba14c157288df338b8cf2f5622d01ff460.zip
Add a half-assed doxygen implementation and start a really bad idea
Signed-off-by: Matt Strapp <matt@mattstrapp.net>
Diffstat (limited to 'docs')
-rw-r--r--docs/C.md43
1 files changed, 43 insertions, 0 deletions
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.
+```