From dfdc4c9426b9852e3c6d25e67f4514ae970b7717 Mon Sep 17 00:00:00 2001 From: Kosma Moczek Date: Mon, 3 Mar 2014 15:31:54 +0100 Subject: [PATCH] README.md: describe library limitations --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index e5ef855..c1718f2 100644 --- a/README.md +++ b/README.md @@ -100,6 +100,17 @@ Building and running the tests requires the following: If you have both in your ``$PATH``, running the tests should be as simple as typing ``make``. +## Limitations + +* Fractional numbers are represented as ``int`` internally, which is 32 bits on + most embedded platforms. Therefore, the maximum supported coordinate precision + is ``[+-]DDDMM.MMMMM``. The library does not check for integer overflow at the + moment; coordinates with more precision will not parse correctly. +* Only a handful of frames is supported right now. +* There's no support for omitting parts of the library from building. As + a workaround, use the ``-ffunction-sections -Wl,--gc-sections`` linker flags + (or equivalent) to remove the unused functions (parsers) from the final image. + ## Bugs There are plenty. Report them on GitHub, or - even better - open a pull request.