[Cryptech-Commits] [user/sra/libtfm] 05/05: Add README.md.

[git at cryptech.is]

This is an automated email from the git hooks/post-receive script.

sra at hactrn.net pushed a commit to branch master
in repository user/sra/libtfm.

commit 8eeb885e5bc92ecba31631f1cbf4da2d131f44de
Author: Rob Austein <sra at hactrn.net>
Date:   Fri Jun 19 13:35:47 2015 -0400

    Add README.md.
---
 README.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7641956
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+libtfm
+======
+
+This is a trivial port of the Tom's Fast Math (TFM) bignum library to
+the Cryptech environment.  At least for now, this just checks the
+package out from GitHub, verifies that the SHA-256 digest of the
+commit we're using matches a known value, and builds the library with
+the options we want.
+
+See tomsfastmath/doc/tfm.pdf for API details.
+
+In theory, the need for most (perhaps all) of this will go away when
+more of the bignum math is implemented in Verilog.  Part of the reason
+for using the TFM library is that its extremely modular structure make
+it easy for us to link in only the functions we need.