Finished requirements section

This commit is contained in:
James P. Howard, II
2021-09-21 21:26:09 -04:00
parent f3f2b00740
commit 52bb8bb900

View File

@@ -2,8 +2,19 @@
## Requirements
The core of Kami, `libkami` has no requirements beyond a modern C++ compiler. However, both the examples provided and
the
The core of Kami, `libkami`, has no requirements beyond a modern C++ compiler. However, both the examples provided and
the unit tests provided rely on three additional C++ packages:
* cli11/1.9.1
* spdlog/1.8.5
* fmt/7.1.3
[`CLI11`](https://cliutils.github.io/CLI11/) provides a command line interface for each of the utilities that makeup the
examples and test suite. [`spdlog`](https://github.com/gabime/spdlog)
provides a uniform output interface. Coupled with a command line option to set the output level, `spdlog` allows the
unit tests and example programs to provide variable output levels depending on the users needs.
Finally, [`fmt`](https://fmt.dev/) is required by
`spdlog` for simple and easy string formatting.
## Compiling