libtommath/README.md

# 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

### Travis CI

master: [![Build Status](https://api.travis-ci.org/libtom/libtommath.png?branch=master)](https://travis-ci.org/libtom/libtommath)

develop: [![Build Status](https://api.travis-ci.org/libtom/libtommath.png?branch=develop)](https://travis-ci.org/libtom/libtommath)

### AppVeyor

master: [![Build status](https://ci.appveyor.com/api/projects/status/b80lpolw3i8m6hsh/branch/master?svg=true)](https://ci.appveyor.com/project/libtom/libtommath/branch/master)

develop: [![Build status](https://ci.appveyor.com/api/projects/status/b80lpolw3i8m6hsh/branch/develop?svg=true)](https://ci.appveyor.com/project/libtom/libtommath/branch/develop)

### ABI Laboratory

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 stand-alone test binary that executes several test routines.
* `make mtest_opponent` 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 | ./mtest_opponent`.
  `mtest` is creating test vectors using an alternative MPI library and `test` is consuming these vectors to verify correct behavior of ltm

## Building and Installing

Building is straightforward for GNU Linux only, the section "Building LibTomMath" in the documentation in `doc/bn.pdf` has the details.
improve README 2017-10-14 16:50:04 +00:00			`# libtommath`
show master build state on main pagein readme 2016-04-24 11:49:58 +00:00
improve README 2017-10-14 16:50:04 +00:00			`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.`
add Travis CI 2015-11-18 19:24:58 +00:00
improve README 2017-10-14 16:50:04 +00:00			`## Build Status`

add appveyor badges [skip ci] 2019-06-30 10:09:05 +00:00			`### Travis CI`

update README.md 2017-12-06 22:46:42 +00:00			`master: [![Build Status](https://api.travis-ci.org/libtom/libtommath.png?branch=master)](https://travis-ci.org/libtom/libtommath)`
improve README 2017-10-14 16:50:04 +00:00
update README.md 2017-12-06 22:46:42 +00:00			`develop: [![Build Status](https://api.travis-ci.org/libtom/libtommath.png?branch=develop)](https://travis-ci.org/libtom/libtommath)`

add appveyor badges [skip ci] 2019-06-30 10:09:05 +00:00			`### AppVeyor`

			`master: [![Build status](https://ci.appveyor.com/api/projects/status/b80lpolw3i8m6hsh/branch/master?svg=true)](https://ci.appveyor.com/project/libtom/libtommath/branch/master)`

			`develop: [![Build status](https://ci.appveyor.com/api/projects/status/b80lpolw3i8m6hsh/branch/develop?svg=true)](https://ci.appveyor.com/project/libtom/libtommath/branch/develop)`

			`### ABI Laboratory`

update README.md 2017-12-06 22:46:42 +00:00			`API/ABI changes: [check here](https://abi-laboratory.pro/tracker/timeline/libtommath/)`
improve README 2017-10-14 16:50:04 +00:00
			`## Summary`
initial revision 2014-10-18 17:02:44 +00:00
			The `develop` branch contains the in-development version. Stable releases are tagged.

create `mtest_opponent` instead of alt version of `test` 2019-09-10 14:05:27 +00:00			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.
initial revision 2014-10-18 17:02:44 +00:00
create `mtest_opponent` instead of alt version of `test` 2019-09-10 14:05:27 +00:00			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.`
initial revision 2014-10-18 17:02:44 +00:00
improve README 2017-10-14 16:50:04 +00:00			`## Testing`

update README 2014-10-18 18:20:07 +00:00			Tests are located in `demo/` and can be built in two flavors.
create `mtest_opponent` instead of alt version of `test` 2019-09-10 14:05:27 +00:00			* `make test` creates a stand-alone test binary that executes several test routines.
			* `make mtest_opponent` 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 \| ./mtest_opponent`.
			`mtest` is creating test vectors using an alternative MPI library and `test` is consuming these vectors to verify correct behavior of ltm
added building howto for OpenBSD 2019-02-28 20:43:37 +00:00
			`## Building and Installing`

			Building is straightforward for GNU Linux only, the section "Building LibTomMath" in the documentation in `doc/bn.pdf` has the details.