v0.1.0 release

bksaiki · Oct 9, 2023 · 88b876a · 88b876a
1 parent 1f51511
commit 88b876a
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,11 @@
+# Changes
+
+## [0.1.0] - 08 March 2023
+
+This is `mpmfnum`'s first release.
+
+The library supports various floating-point and fixed-point formats.
+The API has mostly stabilized but things are bound to change in a future release.
+
+<!-- next-url -->
+[0.1.0]: https://github.com/egraphs-good/egg/tree/v0.1.0
diff --git a/README.md b/README.md
@@ -1,4 +1,15 @@
-# mpmfnum-rust
-A library for simulating number systems.
+# mpmfnum
+
+Rust library for simulating number systems.
 
 Supports IEEE-754 floating-point numbers, fixed-point numbers, and more.
+Inspired by [FPCore](https://fpbench.org/) and
+  Bill Zorn's [Titanic](https://github.com/billzorn/titanic) library.
+
+## Using mpmfnum
+
+Add `mpmfnum` to your `Cargo.toml` like this:
+```toml
+[dependencies]
+mpmfnum = "0.1.0"
+```