aboutsummaryrefslogtreecommitdiffstats
path: root/docs/C.md
blob: d0ac30ec6595bd266db8948b094da397770f7816 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
# liboCusts

[![CI](https://github.com/locusts-r-us/locusts/actions/workflows/c.yml/badge.svg)](https://github.com/locusts-r-us/locusts/actions/workflows/c.yml)

## Description

liboCusts is a member of a [series of libraries](https://github.com/locusts-r-us/locusts) that allows you to introduce locusts into your codebase.

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](https://github.com/locusts-r-us/locusts/blob/master/LICENSE) file for details.