aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorMatt Strapp <matt@mattstrapp.net>2024-08-05 14:32:56 -0500
committerMatt Strapp <matt@mattstrapp.net>2024-08-05 14:32:56 -0500
commit38c5e18b94c1f2f506b89cfa582b4aba80fe48d7 (patch)
treeee0b2a7cec961f3f2d04057e269695eddf132afc /README.md
parentNothing? (diff)
downloadlocusts-38c5e18b94c1f2f506b89cfa582b4aba80fe48d7.tar
locusts-38c5e18b94c1f2f506b89cfa582b4aba80fe48d7.tar.gz
locusts-38c5e18b94c1f2f506b89cfa582b4aba80fe48d7.tar.bz2
locusts-38c5e18b94c1f2f506b89cfa582b4aba80fe48d7.tar.lz
locusts-38c5e18b94c1f2f506b89cfa582b4aba80fe48d7.tar.xz
locusts-38c5e18b94c1f2f506b89cfa582b4aba80fe48d7.tar.zst
locusts-38c5e18b94c1f2f506b89cfa582b4aba80fe48d7.zip
Add python and a bunch of documentation
Signed-off-by: Matt Strapp <matt@mattstrapp.net>
Diffstat (limited to 'README.md')
-rw-r--r--README.md43
1 files changed, 2 insertions, 41 deletions
diff --git a/README.md b/README.md
index 7865ba5..210a8c5 100644
--- a/README.md
+++ b/README.md
@@ -1,42 +1,3 @@
-# liboCusts
+# Locusts: A universal library
-## 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. \ No newline at end of file
+We here at Locusts-R-Us have developed a series of libraries for all sorts of programming languages to introduce locusts in all sorts of codebases. \ No newline at end of file