diff --git a/README.md b/README.md index 3077cc6..9415c80 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ Meant for systems with very few resources, such as embedded systems. During compile-time, the string to be formatted is preprocessed to the point, only the actual values to be formatted have to be written (If they are not available at compile time). -For example `One number: {:08}; And another one: {:05.3}` is preprocessed into `One number: 000; And another one: 00.000`. +For example `One number: {:03}; And another one: {:05.3}` is preprocessed into `One number: 000; And another one: 00.000`. This is returned as a `std::array`, where `N` is automatically evaluated. The only code executed at compile time then formats the numbers and writes them into their place in the array. @@ -36,4 +36,12 @@ $ cmake --build build/ 4. Run the tests ```bash $ ctest --test-dir build/ -``` \ No newline at end of file +``` + +## Limitations + +Only a relatively limited subset of the `fmtlib` syntax is recognized (for now anyway). In particular, +there is no support for positional arguments, alignment, chrono format specs and custom format specifications. + +By nature of the library design, which forces compile-time preprocessing of the format string, no dynamic width or +dynamic precision can be implemented.