Add a half-assed doxygen implementation and start a really bad idea

Signed-off-by: Matt Strapp <matt@mattstrapp.net>

1 files changed, 43 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c5e2094
--- /dev/null
+++ b/README.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.
+```