From db2b31a335b531d7e54ab3e7d494bbf33050ac60 Mon Sep 17 00:00:00 2001 From: sanine-a Date: Fri, 2 Jul 2021 23:44:51 -0500 Subject: update installation and development sections of README.md --- README.md | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2bcfa71..55c1e5d 100644 --- a/README.md +++ b/README.md @@ -25,9 +25,17 @@ Installation [(Back to top)](#table-of-contents) -Just copy `honeysuckle.h` and `honeysuckle.c` into your project. -**honeysuckle** depends on the Lua libraries, so make sure you have them -installed before using. +```bash +mkdir build +cd build +cmake .. +make +sudo make install +``` + +To make the tests as well, do the above and then do `make test`. + +You should now be able to include `` into your C files for use. Usage ----- @@ -276,6 +284,12 @@ Development 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: + +1. Finish writing the basic tests +2. Write implementations for the API described above +3. Expand the test cases + License ------- -- cgit v1.2.1