diff options
| author | sanine-a <sanine.not@pm.me> | 2021-07-02 23:44:51 -0500 |
|---|---|---|
| committer | sanine-a <sanine.not@pm.me> | 2021-07-02 23:44:51 -0500 |
| commit | db2b31a335b531d7e54ab3e7d494bbf33050ac60 (patch) | |
| tree | 2dff284d803a3c03c8bbbd9adc18cbc2236bb133 | |
| parent | abb9613d2dbc95966c73409e08f66d812703b844 (diff) | |
update installation and development sections of README.md
| -rw-r--r-- | README.md | 20 |
1 files changed, 17 insertions, 3 deletions
@@ -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 `<honeysuckle.h>` 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 ------- |