aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorScott Beamer <sbeamer@eecs.berkeley.edu>2015-09-16 15:46:51 -0700
committerScott Beamer <sbeamer@eecs.berkeley.edu>2015-09-16 15:46:51 -0700
commit669ffa1a83a217f4a5bd207699670e7459a58978 (patch)
tree4abe120b9fa6e9bcbbe2909ddc9b6e3e0f2ae572
parent19c55bae5e49444f2566315b5d32730215f5d3cc (diff)
downloadberkeley-softfloat-3-669ffa1a83a217f4a5bd207699670e7459a58978.zip
berkeley-softfloat-3-669ffa1a83a217f4a5bd207699670e7459a58978.tar.gz
berkeley-softfloat-3-669ffa1a83a217f4a5bd207699670e7459a58978.tar.bz2
added readme in markdown format
-rw-r--r--README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1dd8ab8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+Package Overview for Berkeley SoftFloat Release 3
+=================================================
+
+John R. Hauser<br>
+2015 February 16
+
+
+Berkeley SoftFloat is a software implementation of binary floating-point that
+conforms to the IEEE Standard for Floating-Point Arithmetic. SoftFloat is
+distributed in the form of C source code. Building the SoftFloat sources
+generates a library file (typically `softfloat.a` or `libsoftfloat.a`)
+containing the floating-point subroutines.
+
+
+The SoftFloat package is documented in the following files in the
+`doc` subdirectory:
+
+* [SoftFloat.html](http://www.jhauser.us/arithmetic/SoftFloat-3/doc/SoftFloat.html) Documentation for using the SoftFloat functions.
+* [SoftFloat-source.html](http://www.jhauser.us/arithmetic/SoftFloat-3/doc/SoftFloat-source.html) Documentation for building SoftFloat.
+* [SoftFloat-history.html](http://www.jhauser.us/arithmetic/SoftFloat-3/doc/SoftFloat-history.html) History of the major changes to SoftFloat.
+
+Other files in the package comprise the source code for SoftFloat.