Add public API and docs #1

Open
noteuclid wants to merge 8 commits from api into master
Showing only changes of commit f0468502d8 - Show all commits

9
README.md Normal file
View File

@ -0,0 +1,9 @@
# F8: 8-bit floats
> ⚠️ Not for production use!
F8 is a toy software floating-point math library.
It provides an 8-bit floating point type `F8`, with 5 mantissa bits, 3 exponent bits, and no sign bit.
The format used resembles [IEEE 754] binary formats but stripped down to the bare necessities: the only special value supported is zero.
[IEEE 754]: https://en.wikipedia.org/wiki/IEEE_754