commit 704984106421eec1c04de74ce7223a62797563d0 from: Evan Burkey date: Wed Mar 18 19:09:45 2026 UTC txt readme commit - 7c2d060240db9ee8491b728a7c9ea4996bc85dbb commit + 704984106421eec1c04de74ce7223a62797563d0 blob - 171a33440699c49f52cca8fb2fd1d322cfe13875 (mode 644) blob + /dev/null --- README.md +++ /dev/null @@ -1,39 +0,0 @@ -# libflint - -My personal library of common C data structures and algorithms. Supports Linux, macOS, OpenBSD, and FreeBSD. - -## Documentation - -Extensive documentation can be found [here](https://burkey.co/Software+Documentation/libflint/libflint). You can also check out the per-module test files in `tests/` for example usage. - -## Building - -`libflint` requires Cmake to be built. It can then be built using either `cmake` or `make` with the provided build files. The `Makefile` is a wrapper around Cmake for Makefile compatibility. - -### Cmake - -```cmake -# If libflint is in ./lib/libflint -add_subdirectory(lib/libflint) - -# when building target... -target_include_directories(${TARGET} PRIVATE lib/libflint/include) -target_link_libraries(${TARGET} PRIVATE flint ) -``` - -## Testing - -```sh -cmake -B build && cmake --build build -ctest --test-dir build # run all tests -ctest --test-dir build --parallel # run in parallel -ctest --test-dir build --label-exclude slow # skip slow tests (network, macos) -``` - -## Requirements - -Building on Linux requires `libbsd`. Building on macOS, OpenBSD, or FreeBSD requires no extra dependencies. - -## Libraries - -`libflint` includes [uthash](https://github.com/troydhanson/uthash) for a hash table implementation. `uthash` is a single header file included in the source code of `libflint`. See the top of `include/uthash.h` for license information blob - /dev/null blob + 3d1c79e65624c9e4a8fd37b0dcd270e8ecef2cf5 (mode 644) --- /dev/null +++ README @@ -0,0 +1,33 @@ +My personal library of common C data structures and algorithms. Supports Linux, macOS, OpenBSD, and FreeBSD. + +-- Documentation -- + +Extensive documentation can be found at https://burkey.co/Software+Documentation/libflint/libflint. You can also check out the per-module test files in `tests/` for example usage. + +-- Building -- + +`libflint` requires Cmake to be built. It can then be built using either `cmake` or `make` with the provided build files. The `Makefile` is a wrapper around Cmake for Makefile compatibility. + +-- Cmake -- + +# If libflint is in ./lib/libflint +add_subdirectory(lib/libflint) + +# when building target... +target_include_directories(${TARGET} PRIVATE lib/libflint/include) +target_link_libraries(${TARGET} PRIVATE flint ) + +-- Testing -- + +cmake -B build && cmake --build build +ctest --test-dir build # run all tests +ctest --test-dir build --parallel # run in parallel +ctest --test-dir build --label-exclude slow # skip slow tests (network, macos) + +-- Requirements -- + +Building on Linux requires `libbsd`. Building on macOS, OpenBSD, or FreeBSD requires no extra dependencies. + +-- Libraries -- + +`libflint` includes [uthash](https://github.com/troydhanson/uthash) for a hash table implementation. `uthash` is a single header file included in the source code of `libflint`. See the top of `include/uthash.h` for license information