libflint/docs/index.md

25 lines
699 B
Markdown
Raw Permalink Normal View History

2022-03-31 00:02:36 +00:00
# libflint
`libflint` is a library of common C data structures and algorithms, designed to be as agnostic as possible for its
2023-10-25 16:21:59 +00:00
users. Over time, it has become my personal library of reusable C code.
2022-03-31 00:02:36 +00:00
## Requirements
2023-10-25 16:21:59 +00:00
### Linux
Requires `libbsd`. This should be available on all major Linux distros.
### macOS, OpenBSD, FreeBSD
Requires no extra dependencies
2022-03-31 00:02:36 +00:00
## Memory Management
The parts of this library that create data structures pass all responsibility of memory management to the user. This
is clearly documented in the individual module's documentation.
2023-10-25 16:21:59 +00:00
## Why the name 'libflint'?
2022-03-31 00:02:36 +00:00
2023-10-25 16:21:59 +00:00
`libflint` is named after my dog Flint, who passed away in 2021. I miss you buddy.
2022-03-31 00:02:36 +00:00
![flint](flinty.jpg)