diff --git a/README.md b/README.md new file mode 100644 index 0000000..6c856f1 --- /dev/null +++ b/README.md @@ -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