You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+8-2
Original file line number
Diff line number
Diff line change
@@ -30,8 +30,14 @@ Use those packages with caution and at your own discretion.
30
30
31
31
The `develop` branch contains the in-development version. Stable releases are tagged.
32
32
33
-
Documentation is built from the LaTeX file `bn.tex`. There is also limited documentation in `tommath.h`.
34
-
There is also a document, `tommath.pdf`, which describes the goals of the project and many of the algorithms used.
33
+
Documentation is built from the LaTeX file `doc/bn.tex` and available as PDF for each release.
34
+
This PDF is also created as build artifact on each CI run.
35
+
36
+
There is also limited documentation in `tommath.h`.
37
+
38
+
Originally the library contained a document, `tommath.pdf`, which describes the goals of the project and many of the algorithms used at the time.
39
+
This document has been removed since it can't be built anymore and nobody spent the time to fix and update it.
40
+
The latest valid update to that document was done in version [`0.39`](https://github.com/libtom/libtommath/releases/tag/0.39) of the library and it is contained within that tarball.
35
41
36
42
The project can be build by using `make`. Along with the usual `make`, `make clean` and `make install`,
37
43
there are several other build targets, see the makefile for details.
0 commit comments