Commit ce861040 authored by Andreas Enge's avatar Andreas Enge

Improve the installation instructions.

* doc/paritwine.texi: Modify the installation instructions.
* INSTALL: Point to doc/paritwine.texi.
* README: Remove the outdated installation instruction.
* .gitignore: Add generated files in doc/.
parent 45919584
......@@ -43,4 +43,6 @@ test-driver
/doc/paritwine.info
/doc/stamp-vti
/doc/version.texi
/doc/paritwine.pdf
/doc/paritwine.t2p/
Please see the Texinfo documentation in the file doc/paritwine.texi .
......@@ -3,25 +3,6 @@ multiprecision ecosystem (mpz, mpq, mpfr, mpc) and corresponding types in
libpari, as well as to use functions from the GNU libraries in GP.
INSTALLATION
------------
Adapt the location and version numbers of Pari/GP, GNU MP (GMP), GNU MPFR,
GNU MPC and CMH in the first lines of Makefile.
If you wish to use functions relying on GMP, GNU MPFR, GNU MPC or CMH in your
GP session, you need to add them to paritwine-user.h and paritwine-user.c
(see below).
Execute
make
This creates the library libparitwine.so. There is no need to install this
library, it may simply be copied to the location of your Pari/GP project.
To test if everything went well, execute
make check
NUMBER TRANSFORMATIONS
----------------------
......
\input texinfo
@setfilename paritwine.info
@include version.texi
@settitle PARITWINE @value{VERSION}
@settitle PariTwine @value{VERSION}
@set AUTHORS Andreas Enge, Fredrik Johansson
......@@ -10,7 +10,7 @@
@end iftex
@copying
This manual is for PARI-GNUMP, a library to convert between multiprecision
This manual is for PariTwine, a library to convert between multiprecision
types of PARI/GP and external libraries, and to wrap functions from these
libraries for use in GP,
version @value{VERSION} of @value{UPDATED-MONTH}.
......@@ -27,7 +27,7 @@ entitled ``GNU Free Documentation License.''
@end copying
@titlepage
@title PARI-GNUMP
@title PariTwine
@subtitle Edition @value{VERSION}
@subtitle @value{UPDATED-MONTH}
@author @value{AUTHORS}
......@@ -39,9 +39,9 @@ entitled ``GNU Free Documentation License.''
@ifnottex
@node Top
@top PARI-GNUMP
@top PariTwine
This manual documents how to install and use the PARI-GNUMP library,
This manual documents how to install and use the PariTwine library,
version @value{VERSION}
@end ifnottex
......@@ -50,21 +50,21 @@ version @value{VERSION}
@end ifnothtml
@menu
* Copying:: PARI-GNUMP Copying Conditions (GPL).
* Introduction to PARI-GNUMP:: Brief introduction to PARI-GNUMP.
* Installing PARI-GNUMP:: How to configure and compile PARI-GNUMP
* Copying:: PariTwine Copying Conditions (GPL).
* Introduction to PariTwine:: Brief introduction to PariTwine.
* Installing PariTwine:: How to configure and compile PariTwine
* GNU Free Documentation License::
@end menu
@node Copying
@unnumbered PARI-GNUMP Copying Conditions
@unnumbered PariTwine Copying Conditions
PARI-GNUMP is free software; you can redistribute it and/or modify it under
PariTwine is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the
Free Software Foundation; either version 2 of the License, or (at your
option) any later version.
PARI-GNUMP is distributed in the hope that it will be useful, but WITHOUT ANY
PariTwine is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for
more details.
......@@ -73,21 +73,20 @@ You should have received a copy of the GNU General Public License
along with this program. If not, see @uref{http://www.gnu.org/licenses/}.
@node Introduction to PARI-GNUMP
@chapter Introduction to PARI-GNUMP
@node Introduction to PariTwine
@chapter Introduction to PariTwine
Write it.
@node Installing PARI-GNUMP
@chapter Installing PARI-GNUMP
@node Installing PariTwine
@chapter Installing PariTwine
To build PARI-GNUMP, you first have to install Pari/GP and
all the desired packages (GMP, MPFR, etc.) on your computer.
You need a C compiler
and you need a
standard Unix @samp{make} program, plus some other standard Unix utility
programs.
To build PariTwine, you first have to install PARI/GP and all the desired
libraries that you wish to wrap (at least GMP, and at your choice any of
GNU MPFR, GNU MPC, FLINT, ARB and CMH) on your computer.
You need a C compiler and a standard Unix @samp{make} program, plus some
other standard Unix utility programs.
Here are the steps needed to install the library on Unix systems:
......@@ -101,7 +100,7 @@ Here are the steps needed to install the library on Unix systems:
@item
@samp{./configure}
If dependencies are installed into standard directories, that is, directories
if dependencies are installed into standard directories, that is, directories
that are searched by default by the compiler and the linking tools.
@samp{./configure --with-gmp=DIR}
......@@ -110,7 +109,7 @@ is used to indicate a different location where GMP is installed.
@samp{./configure --with-pari=DIR}
is used to indicate a different location where Pari/GP is installed.
is used to indicate a different location where PARI/GP is installed.
@samp{./configure --with-mpfr=DIR}
......@@ -132,14 +131,14 @@ is used to indicate a different location where ARB is installed.
is used to indicate a different location where CMH is installed.
For each package, separate search paths for the library
files and header files can be specified as follows:
For each package, separate search paths for the header and library
files can be specified as follows:
@samp{./configure --with-gmp-include=DIR}
@samp{./configure --with-gmp-lib=DIR}
and analogously for the other packages.
Another useful parameter is @samp{--prefix}, which can be used to
......@@ -151,27 +150,30 @@ Use @samp{./configure --help} for an exhaustive list of parameters.
@item
@samp{make}
This compiles PARI-GNUMP in the working directory.
This compiles PariTwine in the working directory.
@item
@samp{make check}
This will make sure PARI-GNUMP was built correctly.
If you get error messages, please report them.
This executes a number of tests on the compiled project.
If you get error messages, please report them to the authors.
@item
@samp{make install}
This will do something.
%This will copy the file @file{mpc.h} to the directory
%@file{/usr/local/include}, the file @file{libmpc.a} to the directory
%@file{/usr/local/lib}, and the file @file{mpc.info} to the directory
%@file{/usr/local/share/info} (or if you passed the @samp{--prefix} option to
%@file{configure}, using the prefix directory given as argument to
%@samp{--prefix} instead of @file{/usr/local}). Note: you need write permissions
%on these directories.
This copies the header files @file{paritwine-config.h} and
@file{paritwine.h} into the directory @file{/usr/local/include},
the static library @file{libparitwine.a} and the dynamic library
@file{libparitwine.so} into the directory @file{/usr/local/lib},
the GP script @file{paritwine.gp} into the directory
@file{/usr/local/share/paritwine} and
the manual @file{paritwine.info} into the directory
@file{/usr/local/share/info}.
If you passed the @samp{--prefix} option to @samp{configure}, the prefix
directory given as argument to @samp{--prefix} is used instead of
@file{/usr/local}.
Note that you need write permissions on the prefix directory and its
subdirectories.
@end enumerate
......@@ -181,47 +183,34 @@ This will do something.
There are some other useful make targets:
@itemize @bullet
@item
@samp{info}
Create an info version of the manual, in @file{paritwine.info}.
@item
@samp{pdf}
Create a PDF version of the manual, in @file{doc/paritwine.pdf}.
@item
@samp{dvi}
Create a DVI version of the manual, in @file{doc/paritwine.dvi}.
@item
@samp{ps}
Create a Postscript version of the manual, in @file{doc/paritwine.ps}.
This creates a PDF version of the manual in @file{doc/paritwine.pdf}.
@item
@samp{html}
Create an HTML version of the manual, in several pages in the
This creates an HTML version of the manual, in several pages in the
directory @file{doc/paritwine.html}; if you want only one output HTML file,
then type @samp{makeinfo --html --no-split mpc.texi} instead.
then type @samp{makeinfo --html --no-split paritwine.texi} instead.
@item
@samp{clean}
Delete all object files and archive files, but not the configuration files.
This deletes all object files and archive files, but not the configuration
files.
@item
@samp{distclean}
Delete all files not included in the distribution.
This has the same effect as @samp{make clean}, but it additionally deletes
the configuration files created by @samp{./configure}.
@item
@samp{uninstall}
Delete all files copied by @samp{make install}.
This deletes all files copied by @samp{make install}.
@end itemize
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment