aboutsummaryrefslogtreecommitdiffstats
path: root/docs/C.md
diff options
context:
space:
mode:
authorMatt Strapp <matt@mattstrapp.net>2024-08-06 09:20:36 -0500
committerMatt Strapp <matt@mattstrapp.net>2024-08-06 09:42:20 -0500
commitf33ddce9267f934332653d78b775a3d29552151b (patch)
tree7aad50cc832f55990201cab0dfea592c660be94f /docs/C.md
parentAdd Meson to GHA (diff)
downloadlocusts-f33ddce9267f934332653d78b775a3d29552151b.tar
locusts-f33ddce9267f934332653d78b775a3d29552151b.tar.gz
locusts-f33ddce9267f934332653d78b775a3d29552151b.tar.bz2
locusts-f33ddce9267f934332653d78b775a3d29552151b.tar.lz
locusts-f33ddce9267f934332653d78b775a3d29552151b.tar.xz
locusts-f33ddce9267f934332653d78b775a3d29552151b.tar.zst
locusts-f33ddce9267f934332653d78b775a3d29552151b.zip
Format all documentation
Signed-off-by: Matt Strapp <matt@mattstrapp.net>
Diffstat (limited to '')
-rw-r--r--docs/C.md15
1 files changed, 11 insertions, 4 deletions
diff --git a/docs/C.md b/docs/C.md
index 27ea047..0ab3aef 100644
--- a/docs/C.md
+++ b/docs/C.md
@@ -1,36 +1,42 @@
# 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;
+ 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
@@ -38,4 +44,5 @@ make
```
## License
-This project is licensed under the BSD Zero Clause License. See the [LICENSE](../LICENSE) file for details. \ No newline at end of file
+
+This project is licensed under the BSD Zero Clause License. See the [LICENSE](../LICENSE) file for details.