Check all possible opcodes for PartitionedEqGtGe

[ieee754fpu.git] / README.md

diff --git a/README.md b/README.md
index dc09b92c64d641b3b8945e8469c4ffa3d734e454..ad2c7c949a960ef19604611194d73e5858edc159 100644 (file)
--- a/README.md
+++ b/README.md
@@ -10,8 +10,29 @@ may be used in any project (not limited to one specific processor).
 * yosys (latest git repository, required by nmigen)
 * sfpy (running unit tests).  provides python bindings to berkeley softfloat-3
 
+# Building sfpy
+
+The standard sfpy will not work without being modified to the type of
+IEEE754 FP emulation being tested.  This FPU is emulating RISC-V, and
+there is some weirdness in x86 IEEE754 implementations when it comes
+to FP16 non-canonical NaNs.
+
+The following modifications are required to the sfpy berkeley-softfloat-3
+submodule:
+
+    cd /path/to/sfpy/berkeley-softfloat-3
+    git apply /path/to/ieee754fpu/berkeley-softfloat.patch
+
+
+
+The following modifications are required to the sfpy SoftPosit Makefile:
+
+    cd /path/to/sfpy/SoftPosit
+    git apply /path/to/ieee754fpu/SoftPosit.patch
+
 # Useful resources
 
 * https://en.wikipedia.org/wiki/IEEE_754-1985
 * http://weitz.de/ieee/
 * https://steve.hollasch.net/cgindex/coding/ieeefloat.html
+