diff options
Diffstat (limited to 'libtommath/README.md')
| -rw-r--r-- | libtommath/README.md | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/libtommath/README.md b/libtommath/README.md new file mode 100644 index 0000000..0e57a4d --- /dev/null +++ b/libtommath/README.md @@ -0,0 +1,25 @@ +# libtommath + +This is the git repository for [LibTomMath](http://www.libtom.net/LibTomMath/), a free open source portable number theoretic multiple-precision integer (MPI) library written entirely in C. + +## Build Status + +master: [](https://travis-ci.org/libtom/libtommath) + +develop: [](https://travis-ci.org/libtom/libtommath) + +API/ABI changes: [check here](https://abi-laboratory.pro/tracker/timeline/libtommath/) + +## Summary + +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. + +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. + +## Testing + +Tests are located in `demo/` and can be built in two flavors. +* `make test` creates a test binary that is intended to be run against `mtest`. `mtest` can be built with `make mtest` and test execution is done like `./mtest/mtest | ./test`. `mtest` is creating test vectors using an alternative MPI library and `test` is consuming these vectors to verify correct behavior of ltm +* `make test_standalone` creates a stand-alone test binary that executes several test routines. |