Small optimization in simplify_indexed.
[ginac.git] / INSTALL.CMake
1 PREREQUISITES
2 =============
3
4 1. A decent ANSI-compliant C++ compiler. GCC (version >= 4.4) is recommended.
5 2. CLN library (http://www.ginac.de/CLN), version >= 1.2.2
6 3. CMake, version >= 2.8 (version 2.6.x might work too).
7 4. Python, version >= 2.6
8 5. (optional) pkg-config utility (http://pkg-config.freedesktop.org)
9 6. (optional) bison (>= 2.3), flex (2.5.33), GNU readline (>= 4.3). These
10    are necessary to build ginsh, the GiNaC interactive shell, and can be
11    skipped if you don't intend to use ginsh (i.e. you need the GiNaC library
12    for compiling another piece of a software).
13 7. (optional) To build the GiNaC tutorial and reference manual the doxygen
14    utility (it can be downloaded from http://www.stack.nl/~dimitri/doxygen)
15    and TeX are necessary.
16
17 INSTALLATION
18 ============
19
20 To install from a source distribution:
21 --------------------------------------
22
23 1) Unpack the tarball
24
25  $ tar xaf GiNaC-x.y.z.tar.bz2
26
27 2) Create a build directory
28
29  $ mkdir ginac_build
30
31 3) Run CMake to generate Makefile's
32
33  $ cd ginac_build
34  $ cmake ../GiNaC-x.y.z
35
36 4) Actually build GiNaC
37
38  $ make
39
40 5) Run the test and benchmark suite (not mandatory, but strongly recommended)
41
42  $ make check
43
44 6) Install GiNaC
45
46  [become root if necessary]
47  # make install
48
49 To install from git: 
50 --------------------
51
52 The steps are essentially the same as compiling from the tarball, the only
53 difference is using git to get the code.
54
55 1) Download the code:
56
57   $ git clone git://www.ginac.de/ginac.git ginac
58   
59   or, if you have already cloned the repository,
60
61   $ git pull
62
63 Subsequent steps are the same as compiling from a source tarball.
64