aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorScott Beamer <sbeamer@eecs.berkeley.edu>2015-09-16 15:56:37 -0700
committerScott Beamer <sbeamer@eecs.berkeley.edu>2015-09-16 15:56:37 -0700
commit2ba45d10128b470a330b5981d6f4b467014244c4 (patch)
tree17ad3015d52bf9543b18d403e25f9169130dbf84
parent1f3c9f58f8287cdc1252f7f771ba0dfecf0c9950 (diff)
downloadberkeley-testfloat-3-2ba45d10128b470a330b5981d6f4b467014244c4.zip
berkeley-testfloat-3-2ba45d10128b470a330b5981d6f4b467014244c4.tar.gz
berkeley-testfloat-3-2ba45d10128b470a330b5981d6f4b467014244c4.tar.bz2
added readme in markdown format
-rw-r--r--README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d14df2a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+Package Overview for Berkeley TestFloat Release 3
+=================================================
+
+John R. Hauser<br>
+2015 February 16
+
+
+Berkeley TestFloat is a small collection of programs for testing that an
+implementation of binary floating-point conforms to the IEEE Standard for
+Floating-Point Arithmetic. TestFloat is distributed in the form of C source
+code.
+
+
+The TestFloat package is documented in the following files in the
+`doc` subdirectory:
+
+* [TestFloat-general.html](http://www.jhauser.us/arithmetic/TestFloat-3/doc/TestFloat-general.html) General documentation for understanding and using the TestFloat programs.
+* [testfloat_gen.html](http://www.jhauser.us/arithmetic/TestFloat-3/doc/testfloat_gen.html) Specific documentation for the `testfloat_gen` program.
+* [testfloat_ver.html](http://www.jhauser.us/arithmetic/TestFloat-3/doc/testfloat_ver.html) Specific documentation for the `testfloat_ver` program.
+* [testfloat.html](http://www.jhauser.us/arithmetic/TestFloat-3/doc/testfloat.html) Specific documentation for the all-in-one `testfloat` program.
+* [testsoftfloat.html](http://www.jhauser.us/arithmetic/TestFloat-3/doc/testsoftfloat.html) Specific documentation for the `testsoftfloat` program.
+* [timesoftfloat.html](http://www.jhauser.us/arithmetic/TestFloat-3/doc/timesoftfloat.html) Specific documentation for the `timesoftfloat` program.
+* [TestFloat-source.html](http://www.jhauser.us/arithmetic/TestFloat-3/doc/TestFloat-source.html) Documentation for building TestFloat.
+* [TestFloat-history.html](http://www.jhauser.us/arithmetic/TestFloat-3/doc/TestFloat-history.html) History of the major changes to TestFloat.
+
+Other files in the package comprise the source code for TestFloat.