aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/C.md15
-rw-r--r--docs/Go.md10
-rw-r--r--docs/Python.md12
-rw-r--r--docs/Rust.md14
4 files changed, 37 insertions, 14 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.
diff --git a/docs/Go.md b/docs/Go.md
index 6532847..87813d1 100644
--- a/docs/Go.md
+++ b/docs/Go.md
@@ -1,26 +1,30 @@
# Locusts
## Description
+
Locusts is a library that provides a way to introduce locusts into your code.
Why would you want to do that? I don't know.
## Installation
+
```sh
go get github.com/locusts-r-us/locusts
```
## Example
+
```go
package main
import "github.com/locusts-r-us/locusts"
func main() {
- locusts.IntroduceLocusts()
- /* Locusts are now in your codebase! */
+ locusts.IntroduceLocusts()
+ // Locusts are now in your codebase!
}
```
## 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.
diff --git a/docs/Python.md b/docs/Python.md
index 768ed33..6d01754 100644
--- a/docs/Python.md
+++ b/docs/Python.md
@@ -1,26 +1,30 @@
# locusts-r-us
## Description
+
locusts-r-us is a library that provides a way to introduce locusts into your code.
Why would you want to do that? I don't know.
## Installation
+
```sh
pip install locusts-r-us
```
## Example
+
```python
import locusts
def main():
- locusts.introduce_locusts()
- # Locusts are now in your codebase!
+ locusts.introduce_locusts()
+ # Locusts are now in your codebase!
if __name__ == "__main__":
- main()
+ main()
```
## 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.
diff --git a/docs/Rust.md b/docs/Rust.md
index 11f232d..b01a943 100644
--- a/docs/Rust.md
+++ b/docs/Rust.md
@@ -1,29 +1,37 @@
# locusts
## Description
+
locusts is a library that provides a way to introduce locusts into your code.
Why would you want to do that? I don't know.
## Installation
+
Add this to your `Cargo.toml`:
+
```toml
[dependencies]
locusts = "1"
```
+
or
+
```sh
cargo add locusts
```
## Example
+
```rust
use locusts;
fn main() {
- locusts::introduce_locusts();
- /* Locusts are now in your codebase! */
+ locusts::introduce_locusts();
+ // Locusts are now in your codebase!
}
```
+
## 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.