diff --git a/README.md b/README.md index 9c9f2492..32f6d9c6 100644 --- a/README.md +++ b/README.md @@ -3,25 +3,47 @@ The header-only part of the Lol Engine framework. -| header | category | description | -|--------|:--------:|-------------| -| `` | system | command-line parsing | -| `` | system | portable file dialogs (imported from [here](https://github.com/samhocevar/portable-file-dialogs)) | -| `` | system | file reading utilities | -| `` | system | simple message logging | -| `` | system | threading and timers | -| `` | system | unit test framework | -| `` | system | various utilities: environment variables, string formatting, std::map and std::vector extensions… | -| `` | containers | n-dimensional dynamic array container | -| `` | text | the PEGTL parsing library (imported from [here](https://github.com/taocpp/PEGTL) | -| `` | text | suffix array library (imported from [here](https://github.com/storm-ptr/step) | -| `` | graphics | color conversions | -| `` | graphics | image loading, saving, and processing | -| `` | math | big integer calculations | -| `` | math | half-precision (16-bit) floating point numbers | -| `` | math | math constants, functions, random number generators, polynomials | -| `` | math | Perlin and simplex noise | -| `` | math | arbitrary precision floating point numbers | -| `` | math | quaternion, matrix and SQT transformation utilities | -| `` | math | GLSL-compatible vector classes | +## Sytem headers + +| header | description | examples | +|--------|-------------|----------| +| `` | command-line parsing (imported from [cliutils/cli11](https://github.com/CLIUtils/CLI11)) | | +| `` | portable file dialogs (imported from [samhocevar/portable-file-dialogs](https://github.com/samhocevar/portable-file-dialogs)) | | +| `` | file reading utilities | | +| `` | simple message logging | | +| `` | threading and timers | | +| `` | unit test framework | | +| `` | various utilities: environment variables, string formatting, std::map and std::vector extensions… | | + +## Containers + +| header | description | examples | +|--------|-------------|----------| +| `` | n-dimensional dynamic array containers | ● `lol::narray`
● `lol::array2d` and `lol::array3d`
● `lol::narray_view`
● `lol::array2d_view` and `lol::array3d_view` | + +## Text utilities + +| header | description | examples | +|--------|-------------|----------| +| `` | the PEGTL parsing library (imported from [taocpp/pegtl](https://github.com/taocpp/PEGTL)) | | +| `` | suffix array library (imported from [storm-ptr/step](https://github.com/storm-ptr/step)) | | + +## Graphics + +| header | description | examples | +|--------|-------------|----------| +| `` | colorspace conversions (RGB, sRGB, HSV…) | | +| `` | image loading, saving, and processing | | + +## Math + +| header | description | examples | +|--------|-------------|----------| +| `` | big integer calculations | | +| `` | half-precision (16-bit) floating point numbers | | +| `` | math constants, functions, random number generators, polynomials | | +| `` | Perlin and simplex noise | | +| `` | arbitrary precision floating point numbers | | +| `` | quaternion, matrix and SQT transformation utilities | | +| `` | GLSL-compatible vector classes | |