summaryrefslogtreecommitdiff
path: root/libs/honeysuckle/README.md
diff options
context:
space:
mode:
authorsanine <sanine.not@pm.me>2022-04-16 11:55:09 -0500
committersanine <sanine.not@pm.me>2022-04-16 11:55:09 -0500
commitdb81b925d776103326128bf629cbdda576a223e7 (patch)
tree58bea8155c686733310009f6bed7363f91fbeb9d /libs/honeysuckle/README.md
parent55860037b14fb3893ba21cf2654c83d349cc1082 (diff)
move 3rd-party librarys into libs/ and add built-in honeysuckle
Diffstat (limited to 'libs/honeysuckle/README.md')
-rw-r--r--libs/honeysuckle/README.md78
1 files changed, 78 insertions, 0 deletions
diff --git a/libs/honeysuckle/README.md b/libs/honeysuckle/README.md
new file mode 100644
index 0000000..6919f58
--- /dev/null
+++ b/libs/honeysuckle/README.md
@@ -0,0 +1,78 @@
+---
+layout: base
+title: honeysuckle README
+---
+
+honeysuckle
+===========
+
+A pure C library to make writing Lua bindings simple. honeysuckle provides
+functions to make argument parsing, table operations, error creation and
+handling, string wrangling, and registry operations easy and straightforward
+from within your C code.
+
+Table of contents
+-----------------
+
+- [Installation](#installation)
+- [Documentation](#documentation)
+- [Development](#development)
+- [License](#license)
+- [Footer](#footer)
+
+Installation
+------------
+
+[(Back to top)](#table-of-contents)
+
+honeysuckle requires CMake and the Lua 5.1 development files.
+
+First, [download a honeysuckle release](/projects/honeysuckle/releases),
+and then do
+
+```bash
+mkdir build
+cd build
+cmake ..
+make
+sudo make install
+```
+
+You should now be able to include `<honeysuckle.h>` into your C
+files for use.
+
+To make the tests as well, do the above and then do `make test`.
+To make the examples, do `make examples`.
+
+
+Documentation
+-----
+
+You can view the honeysuckle documentation [on the honey wiki](https://honey3d.org/wiki/doku.php?id=honeysuckle).
+
+Development
+-----------
+[(Back to top)](#table-of-contents)
+
+honeysuckle is still very early in development. As the specifics of
+the build process and testing become clearer I'll update this
+section.
+
+If you're interested in helping out, send me an email! The to-dos at
+the time of writing are:
+
+* Write initial tests for errors, tracebacks, and function calling
+* Implement everything
+* Expand the test cases.
+
+License
+-------
+
+[(Back to top)](#table-of-contents)
+
+
+honeysuckle is licensed under the [Anti-Capitalist Software License].
+Basically: if you're a single person, a co-op, or a nonprofit, feel free to
+use this. Otherwise, send me an email. c:
+
+[Anti-Capitalist Software License]: https://anticapitalist.software