Mercurial > dropbear
comparison libtommath/README.md @ 1739:13d834efc376 fuzz
merge from main
| author | Matt Johnston <matt@ucc.asn.au> |
|---|---|
| date | Thu, 15 Oct 2020 19:55:15 +0800 |
| parents | 1051e4eea25a |
| children |
comparison
equal
deleted
inserted
replaced
| 1562:768ebf737aa0 | 1739:13d834efc376 |
|---|---|
| 1 [](https://travis-ci.org/libtom/libtommath) | 1 # libtommath |
| 2 | 2 |
| 3 [](https://travis-ci.org/libtom/libtommath) | 3 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. |
| 4 | 4 |
| 5 This is the git repository for [LibTomMath](http://www.libtom.org/), a free open source portable number theoretic multiple-precision integer (MPI) library written entirely in C. | 5 ## Build Status |
| 6 | |
| 7 ### Travis CI | |
| 8 | |
| 9 master: [](https://travis-ci.org/libtom/libtommath) | |
| 10 | |
| 11 develop: [](https://travis-ci.org/libtom/libtommath) | |
| 12 | |
| 13 ### AppVeyor | |
| 14 | |
| 15 master: [](https://ci.appveyor.com/project/libtom/libtommath/branch/master) | |
| 16 | |
| 17 develop: [](https://ci.appveyor.com/project/libtom/libtommath/branch/develop) | |
| 18 | |
| 19 ### ABI Laboratory | |
| 20 | |
| 21 API/ABI changes: [check here](https://abi-laboratory.pro/tracker/timeline/libtommath/) | |
| 22 | |
| 23 ## Summary | |
| 6 | 24 |
| 7 The `develop` branch contains the in-development version. Stable releases are tagged. | 25 The `develop` branch contains the in-development version. Stable releases are tagged. |
| 8 | 26 |
| 9 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. | 27 Documentation is built from the LaTeX file `bn.tex`. There is also limited documentation in `tommath.h`. |
| 28 There is also a document, `tommath.pdf`, which describes the goals of the project and many of the algorithms used. | |
| 10 | 29 |
| 11 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. | 30 The project can be build by using `make`. Along with the usual `make`, `make clean` and `make install`, |
| 31 there are several other build targets, see the makefile for details. | |
| 32 There are also makefiles for certain specific platforms. | |
| 33 | |
| 34 ## Testing | |
| 12 | 35 |
| 13 Tests are located in `demo/` and can be built in two flavors. | 36 Tests are located in `demo/` and can be built in two flavors. |
| 14 * `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 | 37 * `make test` creates a stand-alone test binary that executes several test routines. |
| 15 * `make test_standalone` creates a stand-alone test binary that executes several test routines. | 38 * `make mtest_opponent` creates a test binary that is intended to be run against `mtest`. |
| 39 `mtest` can be built with `make mtest` and test execution is done like `./mtest/mtest | ./mtest_opponent`. | |
| 40 `mtest` is creating test vectors using an alternative MPI library and `test` is consuming these vectors to verify correct behavior of ltm | |
| 41 | |
| 42 ## Building and Installing | |
| 43 | |
| 44 Building is straightforward for GNU Linux only, the section "Building LibTomMath" in the documentation in `doc/bn.pdf` has the details. |