From ef15300cdf04dc0032c1108085f5c101611e8ea6 Mon Sep 17 00:00:00 2001 From: Andrea Faulds Date: Sat, 18 Oct 2014 19:02:44 +0200 Subject: [PATCH] initial revision --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..be45d5d --- /dev/null +++ b/README.md @@ -0,0 +1,9 @@ +This is the git repository for [LibTomMath](http://www.libtom.org/), a free open source portable number theoretic multiple-precision integer library written entirely in C. + +The `develop` branch contains the in-development version. Stable releases are tagged. + +Documentation is built from the LaTeX file `bn.tex`. There is also limited documentation in `tommath.h`. There is also a document, `tommath.pdf`, which describes the goals of the project and many of the algorithms used. + +Tests are located in `demo/`. + +The project can be build by using `make`. Along with the usual `make`, `make clean` and `make install`, there are several other build targets, see the makefile for details. There are also makefiles for certain specific platforms. \ No newline at end of file