diff --git a/AUTHORS b/AUTHORS index a2ad9939..ece0f088 100644 --- a/AUTHORS +++ b/AUTHORS @@ -1,11 +1,20 @@ Over the years the following people have made contributions to the code of FORM (in alphabetical order) + Joshua Davies + Rafael L. Delgado Denny Fliegner Markus Frank + Florian Herren + Stephen Jones Toshiaki Kaneko Jan Kuipers + Florian Lorkowski + Vitaly Magerya + Andreas Maier + Coenraad Marinissen Andrei Onyshenko Irina Pushkina + Maximilian Reininghaus Thomas Reiter Albert Retey Ben Ruijl diff --git a/INSTALL b/INSTALL index 0e342f94..77cd703e 100644 --- a/INSTALL +++ b/INSTALL @@ -38,10 +38,13 @@ The manual needs a LaTeX installation with the commands "latex" and "dvips" or "pdflatex" available. For the html format the command "htlatex" is needed. The source code documentation needs Doxygen, at least in version 1.3. -As a default, FORM tries to use the GMP library and the zlib library for fast -numerics and compression, respectively. If any of these libraries is not -available, the corresponding feature will be deactivated. GMP should be at least -version 4.2. The zlib library should be a recent version, >= 1.2. +As a default, FORM tries to use the GMP and MPFR libraries for fast numerics, the zlib +and Zstandard (zstd) libraries for fast compression, and the FLINT library for fast +polynomial arithmetic. If any of these libraries is not available, the corresponding +feature will be deactivated. GMP should be at least version 4.2, zlib should be at +least 1.2 and FLINT should be version 3.2 or higher. + +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. Preparations @@ -95,11 +98,30 @@ Use one of the following options ./configure --without-gmp ./configure --without-zlib + ./configure --without-mpfr + ./configure --without-zstd + ./configure --without-flint to prevent FORM from using one of these libraries. The executable will not be linked against this library then and the functionality will be provided by internal code. Usually, you don't need to care about these options. +If you want to build without arbitrary-precision floating-point arithmetic, +configure with: + + ./configure --disable-float + +This disables the float feature. + +On Linux systems with "eu-addr2line" or "addr2line" available, it is strongly +recommended to enable backtracing to help diagnose internal errors. To compile +with backtrace support, configure with: + + ./configure --enable-backtrace + +This is strongly recommended, but may incur a potential small ~1% performance +penalty. + The option ./configure --disable-largefile diff --git a/README.md b/README.md index 888ac3d9..9b4c1abf 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ FORM can match many more complicated patterns and has many more features, as doc Build instructions ------------ -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: +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: ```sh autoreconf -i @@ -60,9 +60,9 @@ For more advanced build options, see the file "[INSTALL](INSTALL)". Additional information ---------------------- -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). +The latest release notes are available on the [Wiki](https://github.com/form-dev/form/wiki/Release-Notes-FORM-5.0); the latest reference manual can be found [here](https://github.com/form-dev/form/releases/download/v4.3.1/form-4.3.1-manual.pdf), and the Form Cookbook can be found [here](https://github.com/form-dev/form/wiki/FORM-Cookbook). -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). +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). Information about copying and licensing of this software can be found in the file "[COPYING](COPYING)".