Skip to content

Commit 7c7fdd0

Browse files
cbmarinijodavies
authored andcommitted
docs: update readme, INSTALL and AUTHORS for v5 release.
1 parent 86c9f7f commit 7c7fdd0

3 files changed

Lines changed: 38 additions & 7 deletions

File tree

AUTHORS

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,20 @@
11
Over the years the following people have made contributions to the code of FORM
22
(in alphabetical order)
3+
Joshua Davies
4+
Rafael L. Delgado
35
Denny Fliegner
46
Markus Frank
7+
Florian Herren
8+
Stephen Jones
59
Toshiaki Kaneko
610
Jan Kuipers
11+
Florian Lorkowski
12+
Vitaly Magerya
13+
Andreas Maier
14+
Coenraad Marinissen
715
Andrei Onyshenko
816
Irina Pushkina
17+
Maximilian Reininghaus
918
Thomas Reiter
1019
Albert Retey
1120
Ben Ruijl

INSTALL

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,13 @@ The manual needs a LaTeX installation with the commands "latex" and "dvips" or
3838
"pdflatex" available. For the html format the command "htlatex" is needed.
3939
The source code documentation needs Doxygen, at least in version 1.3.
4040

41-
As a default, FORM tries to use the GMP library and the zlib library for fast
42-
numerics and compression, respectively. If any of these libraries is not
43-
available, the corresponding feature will be deactivated. GMP should be at least
44-
version 4.2. The zlib library should be a recent version, >= 1.2.
41+
As a default, FORM tries to use the GMP and MPFR libraries for fast numerics, the zlib
42+
and Zstandard (zstd) libraries for fast compression, and the FLINT library for fast
43+
polynomial arithmetic. If any of these libraries is not available, the corresponding
44+
feature will be deactivated. GMP should be at least version 4.2, zlib should be at
45+
least 1.2 and FLINT should be version 3.2 or higher.
46+
47+
To use arbitrary precision floating-point arithmetic in FORM, both GMP and MPFR are required; if either is not available, this feature will not be enabled.
4548

4649

4750
Preparations
@@ -95,11 +98,30 @@ Use one of the following options
9598

9699
./configure --without-gmp
97100
./configure --without-zlib
101+
./configure --without-mpfr
102+
./configure --without-zstd
103+
./configure --without-flint
98104

99105
to prevent FORM from using one of these libraries. The executable will not be
100106
linked against this library then and the functionality will be provided by
101107
internal code. Usually, you don't need to care about these options.
102108

109+
If you want to build without arbitrary-precision floating-point arithmetic,
110+
configure with:
111+
112+
./configure --disable-float
113+
114+
This disables the float feature.
115+
116+
On Linux systems with "eu-addr2line" or "addr2line" available, it is strongly
117+
recommended to enable backtracing to help diagnose internal errors. To compile
118+
with backtrace support, configure with:
119+
120+
./configure --enable-backtrace
121+
122+
Note that in some cases (but not most!) this may incur a potential small ~1%
123+
performance penalty.
124+
103125
The option
104126

105127
./configure --disable-largefile

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ FORM can match many more complicated patterns and has many more features, as doc
4545
Build instructions
4646
------------
4747

48-
Before building FORM, it is advised to install the optional dependencies `gmp` and `zlib` for better performance. To quickly build FORM, install the `autoconf` and `automake` packages. Then, after cloning the repository, run:
48+
Before building FORM, it is advised to install the optional dependencies `gmp`, `mpfr`, `zstd`, `zlib` and `flint` for better performance. To use arbitrary-precision floating-point arithmetic, both `gmp` and `mpfr` are required; if either is unavailable it will not be enabled. To quickly build FORM, install the `autoconf` and `automake` packages. Then, after cloning the repository, run:
4949

5050
```sh
5151
autoreconf -i
@@ -60,9 +60,9 @@ For more advanced build options, see the file "[INSTALL](INSTALL)".
6060
Additional information
6161
----------------------
6262

63-
The latest reference manual can be found [here](https://github.com/vermaseren/form/releases/download/v4.3.1/form-4.3.1-manual.pdf) and the Form Cookbook can be found [here](https://github.com/vermaseren/form/wiki/FORM-Cookbook).
63+
The latest release notes are available on the [Wiki](https://github.com/form-dev/form/wiki/Release-Notes-FORM-5.0.0); the latest reference manual can be found [here](https://form-dev.github.io/form-docs/stable/manual/), and the Form Cookbook can be found [here](https://github.com/form-dev/form/wiki/FORM-Cookbook).
6464

65-
More background information, a collection of FORM programs, and a number of courses can be found on the official [FORM website](http://www.nikhef.nl/~form) and on the [Wiki](https://github.com/vermaseren/form/wiki).
65+
More background information, a collection of FORM programs, and a number of courses can be found on the official [FORM website](http://www.nikhef.nl/~form) and on the [Wiki](https://github.com/form-dev/form/wiki).
6666

6767
Information about copying and licensing of this software can be found in the file "[COPYING](COPYING)".
6868

0 commit comments

Comments
 (0)