summaryrefslogtreecommitdiffstats
path: root/libtommath/README.md
diff options
context:
space:
mode:
authorjan.nijtmans <nijtmans@users.sourceforge.net>2018-03-01 20:43:31 (GMT)
committerjan.nijtmans <nijtmans@users.sourceforge.net>2018-03-01 20:43:31 (GMT)
commit5753c7a42b638962406f9f7f822e48561e7a6253 (patch)
tree65742203dd83d002e9c923ddf96ddf45460e0d05 /libtommath/README.md
parent6881a1a27437cae50d56f12227e9cfe10c7a49f2 (diff)
downloadtcl-5753c7a42b638962406f9f7f822e48561e7a6253.zip
tcl-5753c7a42b638962406f9f7f822e48561e7a6253.tar.gz
tcl-5753c7a42b638962406f9f7f822e48561e7a6253.tar.bz2
Lots of code cleanup, mainly [https://github.com/libtom/libtommath/pull/102|Pull request #102]
Diffstat (limited to 'libtommath/README.md')
-rw-r--r--libtommath/README.md14
1 files changed, 11 insertions, 3 deletions
diff --git a/libtommath/README.md b/libtommath/README.md
index 4c5da71..3bc491d 100644
--- a/libtommath/README.md
+++ b/libtommath/README.md
@@ -1,8 +1,14 @@
-[![Build Status - master](https://travis-ci.org/libtom/libtommath.png?branch=master)](https://travis-ci.org/libtom/libtommath)
+# libtommath
-[![Build Status - develop](https://travis-ci.org/libtom/libtommath.png?branch=develop)](https://travis-ci.org/libtom/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.
-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.
+## Build Status
+
+master - [![Build Status - master](https://travis-ci.org/libtom/libtommath.png?branch=master)](https://travis-ci.org/libtom/libtommath)
+
+develop - [![Build Status - develop](https://travis-ci.org/libtom/libtommath.png?branch=develop)](https://travis-ci.org/libtom/libtommath)
+
+## Summary
The `develop` branch contains the in-development version. Stable releases are tagged.
@@ -10,6 +16,8 @@ Documentation is built from the LaTeX file `bn.tex`. There is also limited docum
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 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
* `make test_standalone` creates a stand-alone test binary that executes several test routines.