xref: /netbsd-src/external/lgpl3/gmp/dist/INSTALL (revision 9fb66d812c00ebfb445c0b47dea128f32aa6fe96)
1Copyright 1996, 1997, 1999-2002, 2006 Free Software Foundation, Inc.
2
3This file is part of the GNU MP Library.
4
5The GNU MP Library is free software; you can redistribute it and/or modify
6it under the terms of either:
7
8  * the GNU Lesser General Public License as published by the Free
9    Software Foundation; either version 3 of the License, or (at your
10    option) any later version.
11
12or
13
14  * the GNU General Public License as published by the Free Software
15    Foundation; either version 2 of the License, or (at your option) any
16    later version.
17
18or both in parallel, as here.
19
20The GNU MP Library is distributed in the hope that it will be useful, but
21WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
22or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
23for more details.
24
25You should have received copies of the GNU General Public License and the
26GNU Lesser General Public License along with the GNU MP Library.  If not,
27see https://www.gnu.org/licenses/.
28
29
30
31
32
33                          INSTALLING GNU MP
34                          =================
35
36
37These instructions are only for the impatient.  Others should read the install
38instructions in gmp.info.  Use
39
40	info -f doc/gmp.info
41
42from the gmp source directory.
43
44Here are some brief instructions on how to install GMP.  First you need to
45compile.  Since you're impatient, try this
46
47	./configure
48	make
49	make check		<= VERY IMPORTANT!!
50
51If that fails, or you care about the performance of GMP, you need to read the
52full instructions in the chapter "Installing GMP" in the manual.
53
54You should not skip the "make check" part; the risk that the GMP sources are
55miscompiled are unfortunately quite high.  And if they indeed are, "make check"
56is very likely to trigger the compiler-introduced bug.
57
58Optionally, you can install the library with the following command.  This will
59be to /usr/local by default, and you'll probably need to be "root" to be able
60to write there.
61
62	make install
63
64To create the printable documentation from the texinfo source, type "make
65gmp.dvi" or "make gmp.ps".  This requires various "tex" commands.
66
67If you are new to GMP, it is a good idea you at least read the chapter "GMP
68Basics" in the manual.
69
70Some known build problems are noted in the "Installing GMP" chapter of
71the manual.  Please report other problems to gmp-bugs@gmplib.org.
72
73The GMP web site is located here: https://gmplib.org/.
74
75
76----------------
77Local variables:
78mode: text
79fill-column: 78
80End:
81