692e758c779f624cb1800799dec7451fcfad610a
[mpfr.git] / README
1 Copyright 2000-2018 Free Software Foundation, Inc.
2 Contributed by the AriC and Caramba projects, INRIA.
3
4 This file is part of the GNU MPFR Library.
5
6 The GNU MPFR Library is free software; you can redistribute it and/or modify
7 it under the terms of the GNU Lesser General Public License as published by
8 the Free Software Foundation; either version 3 of the License, or (at your
9 option) any later version.
10
11 The GNU MPFR Library is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
13 or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
14 License for more details.
15
16 You should have received a copy of the GNU Lesser General Public License
17 along with the GNU MPFR Library; see the file COPYING.LESSER.  If not, see
18 http://www.gnu.org/licenses/ or write to the Free Software Foundation, Inc.,
19 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
20
21 ##############################################################################
22
23 The GNU MPFR distribution contains the following files:
24 (This does not apply to code retrieved by Subversion.)
25
26 AUTHORS         - the authors of the library
27 BUGS            - bugs in MPFR - please read this file!
28 COPYING         - the GNU General Public License, version 3
29 COPYING.LESSER  - the GNU Lesser General Public License, version 3
30 ChangeLog       - the log of changes
31 INSTALL         - how to install MPFR (see also mpfr.texi)
32 Makefile*       - files for building the library
33 NEWS            - new features with respect to previous versions
34 PATCHES         - empty file (until patches are applied)
35 README          - this file
36 TODO            - what remains to do (any help is welcome!)
37 VERSION         - version of MPFR (next release version if taken by Subversion)
38 ac*.m4          - automatic configuration files
39 ar-lib          - auxiliary installation file
40 compile         - auxiliary installation file
41 config.*        - auxiliary installation files
42 configure*      - configuration files
43 depcomp         - auxiliary installation file
44 doc/            - directory containing documentation (manual, FAQ, etc.)
45 examples/       - directory containing examples
46 install-sh      - installation file
47 ltmain.sh       - auxiliary installation file
48 m4/             - directory containing additional configuration files
49 missing         - auxiliary installation file
50 mpfr.pc.in      - auxiliary pkg-config file
51 src/            - directory containing the MPFR source
52 test-driver     - auxiliary installation file
53 tests/          - directory containing the testsuite (for "make check")
54 tools/          - directory containing various tools
55 tune/           - directory containing files for tuning MPFR
56
57 According to the special exception to the GNU General Public License,
58 the autotools files compile, config.sub, config.guess, ltmain.sh,
59 m4/libtool.m4 and missing are distributed under the same licence of
60 GNU MPFR.
61
62 For any copyright year range specified as YYYY-ZZZZ in this package,
63 note that the range specifies every single year in that closed interval.
64
65
66 You can get the latest source code by Subversion at InriaForge:
67
68   svn checkout svn://scm.gforge.inria.fr/svn/mpfr/trunk mpfr
69
70 or
71
72   svn checkout https://scm.gforge.inria.fr/svn/mpfr/trunk mpfr
73
74 (the last argument can be any directory name). You can use
75
76   svn ls svn://scm.gforge.inria.fr/svn/mpfr/branches
77   svn ls svn://scm.gforge.inria.fr/svn/mpfr/tags
78
79 to get the list of branches or tags (releases), then checkout a
80 particular branch or tag instead of the trunk. Alternatively, you
81 can now use the "https:" scheme (a.k.a. DAV) instead of "svn:".
82 For more information about Subversion, please see:
83
84   * http://svnbook.red-bean.com/ (the official Subversion book);
85   * https://gcc.gnu.org/wiki/SvnHelp (written for GCC developers,
86     but interesting general information can be found there);
87   * http://subversion.apache.org/faq.html (the Subversion FAQ).
88
89 Subversion users should read the file "doc/README.dev" (in the
90 source tree).