Mercurial > dropbear

comparison libtommath/README.md @ 1692:1051e4eea25a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update LibTomMath to 1.2.0 (#84) * update C files * update other files * update headers * update makefiles * remove mp_set/get_double() * use ltm 1.2.0 API * update ltm_desc * use bundled tommath if system-tommath is too old * XMALLOC etc. were changed to MP_MALLOC etc.
author Steffen Jaeckel <s@jaeckel.eu>
date Tue, 26 May 2020 17:36:47 +0200
parents f52919ffd3b1
children
comparison
equal deleted inserted replaced
1691:2d3745d58843 1692:1051e4eea25a
2 2
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. 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 ## Build Status 5 ## Build Status
6 6
7 ### Travis CI
8
7 master: [![Build Status](https://api.travis-ci.org/libtom/libtommath.png?branch=master)](https://travis-ci.org/libtom/libtommath) 9 master: [![Build Status](https://api.travis-ci.org/libtom/libtommath.png?branch=master)](https://travis-ci.org/libtom/libtommath)
8 10
9 develop: [![Build Status](https://api.travis-ci.org/libtom/libtommath.png?branch=develop)](https://travis-ci.org/libtom/libtommath) 11 develop: [![Build Status](https://api.travis-ci.org/libtom/libtommath.png?branch=develop)](https://travis-ci.org/libtom/libtommath)
12
13 ### AppVeyor
14
15 master: [![Build status](https://ci.appveyor.com/api/projects/status/b80lpolw3i8m6hsh/branch/master?svg=true)](https://ci.appveyor.com/project/libtom/libtommath/branch/master)
16
17 develop: [![Build status](https://ci.appveyor.com/api/projects/status/b80lpolw3i8m6hsh/branch/develop?svg=true)](https://ci.appveyor.com/project/libtom/libtommath/branch/develop)
18
19 ### ABI Laboratory
10 20
11 API/ABI changes: [check here](https://abi-laboratory.pro/tracker/timeline/libtommath/) 21 API/ABI changes: [check here](https://abi-laboratory.pro/tracker/timeline/libtommath/)
12 22
13 ## Summary 23 ## Summary
14 24
15 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.
16 26
17 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.
18 29
19 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.
20 33
21 ## Testing 34 ## Testing
22 35
23 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.
24 * `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.
25 * `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.