9dba753cf3119f8bb7c6f617a59e6e3db936b7bd
[ginac.git] / INSTALL
1 Prerequisites
2 =============
3
4 GiNaC requires the CLN library by Bruno Haible, available at
5 <ftp://ftp.santafe.eu/pub/gnu/> or <ftp://ftp.ilog.fr/pub/Users/haible/gnu/>.
6 You will also need a good C++ compiler adhering to the ANSI standard (we 
7 used gcc for development so if you have a different compiler you are on 
8 your own).
9
10
11 Installation
12 ============
13
14 As with any autoconfiguring GNU software, installation is as easy as this:
15
16  $ ./configure
17  $ make
18  $ make check
19 [become root if necessary]
20  $ make install
21
22 Known to work with:
23   - Linux/x86, EGCS-1.1.2 or GCC 2-95.1/2-95.2
24
25 The "configure" script can be given a number of options to enable and
26 disable various features. For a complete list, type:
27
28  $ ./configure --help
29
30 A few of the more important ones:
31
32  --prefix=PREFIX        install architecture-independent files in PREFIX
33                         [defaults to /usr/local]
34  --exec-prefix=EPREFIX  install architecture-dependent files in EPREFIX
35                         [defaults to the value given to --prefix]
36  --disable-shared       suppress the creation of a shared version of libginac
37
38 More detailed installation instructions can be found in the documentation,
39 in the doc/ directory.
40
41 The time the "make" step takes depends heavily on optimization levels.
42 Large amounts of memory (>128MB) will be required by the compiler,
43 also depending on optimization.  To give you a rough idea of what you
44 have to expect the following table may be helpful.  It was measured on
45 a P-III/500MHz with "enough" memory:
46
47 step:         | GCC optimization level:  | comment:
48               |  -O0   |  -O1   |  -O2   |
49 --------------+--------+--------+--------+-------------------------------
50 make          |  ~4m   |  ~6m   |  ~10m  | building shared and static lib
51 make check    |  ~2m   |  ~2m   |  ~7m   | mostly due to compilation
52
53
54 Problems with CLN
55 =================
56
57 You should use at least CLN V1.0.2, since all earlier ones are
58 somewhat buggy.  Even V1.0.1 has a few problems and GiNaC will not
59 support older versions.  Please install it properly on your system
60 before continuing with GiNaC.