c3-lang/libtommath/README.md
Branch
-
Show log
Commit
-
Hash : 9412d1a6
Author :
Date : 2022-02-17T17:18:40
update README Signed-off-by: Steffen Jaeckel <s@jaeckel.eu>
libtommath
This is the git repository for LibTomMath, a free open source portable number theoretic multiple-precision integer (MPI) library written entirely in C.
Build Status
Travis CI
master: 
develop: 
AppVeyor
master:
develop:
ABI Laboratory
API/ABI changes: check here
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 testcreates a stand-alone test binary that executes several test routines. -
make mtest_opponentcreates a test binary that is intended to be run againstmtest.mtestcan be built withmake mtestand test execution is done like./mtest/mtest | ./mtest_opponent.mtestis creating test vectors using an alternative MPI library andtestis 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.
CMake support
The project provides support for the CMake build system.
git clone https://github.com/libtom/libtommath.git
mkdir -p libtommath/build
cd libtommath/build
cmake ..
make -j$(nproc)
A shared library build can be done by setting -DBUILD_SHARED_LIBS=On when invoking the cmake command.
Source
-
README.md
-
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
# 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: [](https://github.com/libtom/libtommath/actions/workflows/main.yml?query=branch%3Amaster+++) develop: [](https://github.com/libtom/libtommath/actions/workflows/main.yml?query=branch%3Adevelop+++) ### AppVeyor master: [](https://ci.appveyor.com/project/libtom/libtommath/branch/master) develop: [](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. ### CMake support The project provides support for the CMake build system. ``` git clone https://github.com/libtom/libtommath.git mkdir -p libtommath/build cd libtommath/build cmake .. make -j$(nproc) ``` A shared library build can be done by setting `-DBUILD_SHARED_LIBS=On` when invoking the `cmake` command.