Merge pull request #571 from libtom/minor-improvements

Minor improvements

.github/workflows/main.yml

@@ -29,7 +29,7 @@ jobs:
     runs-on: ubuntu-20.04
     container: texlive/texlive:latest-full
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: generate PDF
         run: |
           make docs V=1
@@ -129,7 +129,7 @@ jobs:
           - { BUILDOPTIONS: '--with-cc=clang --cflags=-DMP_16BIT --limit-valgrind',                                              SANITIZER: '1', COMPILE_DEBUG: '0', COMPILE_LTO: '0', CONV_WARNINGS: '',        OTHERDEPS: 'clang llvm' }
           - { BUILDOPTIONS: '--with-cc=clang --cflags=-DMP_32BIT --limit-valgrind',                                              SANITIZER: '1', COMPILE_DEBUG: '0', COMPILE_LTO: '0', CONV_WARNINGS: '',        OTHERDEPS: 'clang llvm' }
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: install dependencies
         run: |
           sudo apt-get update -qq
@@ -172,7 +172,7 @@ jobs:
   amalgam:
     runs-on: ubuntu-22.04
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: install dependencies
         run: |
           make amalgamated_timing
@@ -190,7 +190,7 @@ jobs:
           # Shared library build
           - { CMAKEOPTIONS: '-DBUILD_SHARED_LIBS=On'  }
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: install dependencies
         run: |
           sudo apt-get update -qq

CMakeLists.txt

@@ -28,9 +28,25 @@ option(BUILD_TESTING "" OFF)
 include(CTest)
 include(sources.cmake)
 
-# The only direct cmake argument for now
+#-----------------------------------------------------------------------------
+# Options
+#-----------------------------------------------------------------------------
 option(BUILD_SHARED_LIBS "Build shared library and only the shared library if \"ON\", default is static" OFF)
 
+#-----------------------------------------------------------------------------
+# Add support for ccache if desired
+#-----------------------------------------------------------------------------
+find_program(CCACHE ccache)
+
+if(CCACHE)
+    option(ENABLE_CCACHE "Enable ccache." ON)
+endif()
+
+# use ccache if installed
+if(CCACHE AND ENABLE_CCACHE)
+    set(CMAKE_C_COMPILER_LAUNCHER ${CCACHE})
+endif()
+
 #-----------------------------------------------------------------------------
 # Compose CFLAGS
 #-----------------------------------------------------------------------------

README.md

@@ -30,8 +30,14 @@ Use those packages with caution and at your own discretion.
 
 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.
+Documentation is built from the LaTeX file `doc/bn.tex` and available as PDF for each release.
+This PDF is also created as build artifact on each CI run.
+
+There is also limited documentation in `tommath.h`.
+
+Originally the library contained a document, `tommath.pdf`, which describes the goals of the project and many of the algorithms used at the time.
+This document has been removed since it can't be built anymore and nobody spent the time to fix and update it.
+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.
 
 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.