dropbear: libtommath/README.md annotate

annotate libtommath/README.md @ 1521:198e2ee0f4b1

- Fix dependencies and remove old default_options.h from version control - Rename default_options.h.in -> default_options.h, and default_options.h -> default_options_guard.h - Fix newlines in default_options.h

author	Matt Johnston <matt@ucc.asn.au>
date	Mon, 19 Feb 2018 22:16:50 +0800
parents	8bba51a55704
children	f52919ffd3b1

rev	line source
1470 8bba51a55704 Update to libtommath v1.0.1 Matt Johnston <matt@ucc.asn.au> parents: 1436 diff changeset	1 [![Build Status - master](https://travis-ci.org/libtom/libtommath.png?branch=master)](https://travis-ci.org/libtom/libtommath)
8bba51a55704 Update to libtommath v1.0.1 Matt Johnston <matt@ucc.asn.au> parents: 1436 diff changeset	2
8bba51a55704 Update to libtommath v1.0.1 Matt Johnston <matt@ucc.asn.au> parents: 1436 diff changeset	3 [![Build Status - develop](https://travis-ci.org/libtom/libtommath.png?branch=develop)](https://travis-ci.org/libtom/libtommath)
1436 60fc6476e044 Update to libtommath v1.0 Matt Johnston <matt@ucc.asn.au> parents: diff changeset	4
60fc6476e044 Update to libtommath v1.0 Matt Johnston <matt@ucc.asn.au> parents: diff changeset	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.
60fc6476e044 Update to libtommath v1.0 Matt Johnston <matt@ucc.asn.au> parents: diff changeset	6
60fc6476e044 Update to libtommath v1.0 Matt Johnston <matt@ucc.asn.au> parents: diff changeset	7 The `develop` branch contains the in-development version. Stable releases are tagged.
60fc6476e044 Update to libtommath v1.0 Matt Johnston <matt@ucc.asn.au> parents: diff changeset	8
60fc6476e044 Update to libtommath v1.0 Matt Johnston <matt@ucc.asn.au> parents: diff changeset	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.
60fc6476e044 Update to libtommath v1.0 Matt Johnston <matt@ucc.asn.au> parents: diff changeset	10
60fc6476e044 Update to libtommath v1.0 Matt Johnston <matt@ucc.asn.au> parents: diff changeset	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.
60fc6476e044 Update to libtommath v1.0 Matt Johnston <matt@ucc.asn.au> parents: diff changeset	12
60fc6476e044 Update to libtommath v1.0 Matt Johnston <matt@ucc.asn.au> parents: diff changeset	13 Tests are located in `demo/` and can be built in two flavors.
60fc6476e044 Update to libtommath v1.0 Matt Johnston <matt@ucc.asn.au> parents: diff changeset	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
60fc6476e044 Update to libtommath v1.0 Matt Johnston <matt@ucc.asn.au> parents: diff changeset	15 * `make test_standalone` creates a stand-alone test binary that executes several test routines.