diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..4644332 --- /dev/null +++ b/README.md @@ -0,0 +1,40 @@ +libbowl [![][badge]][badge-link] +======= + +The last C datastructure library you will ever use. Provides a +versalite API to build nested, serial and hashed structure nodes. + +Check out the [issue tracker][issues] + +I hope you enjoy ❤ + +[badge]: https://builds.sr.ht/~spacekookie/libbowl.svg +[badge-link]: https://builds.sr.ht/~spacekookie/libbowl? +[issues]: https://todo.sr.ht/~spacekookie/libbowl + + +How to build +------------ + +Build dependencies + +- gcc (`4.0+`) +- cmake (`2.18+`) + +An out-of-source build is recommended. You can specify the linking +behaviour with `-DLINK_DYNAMIC=1`. Optionally you can disable tests +with `-DRUN_TESTS=0`. + +``` +$ mkdir build; cd build +$ cmake .. -DLINK_DYNAMIC=1 -DRUN_TESTS=1 +$ make +``` + +License +------- + +This program is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation; either version 3 of the License, or (at +your option) any later version. |