documentation update (Clifford algebra)

[ginac.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index 5f595f562269319532669b43511e6d5730eaa364..7c6258f3889723389732d7913c2cab8e3b229589 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -12,13 +12,6 @@ different compiler you are on your own.  Note that you may have to use
 the same compiler you compiled CLN with because of differing
 name-mangling schemes.
 
-Optionally, GiNaC may work together with Masaharu Goto's free C++
-interpreter Cint.  You may obtain it from
-  * <ftp://root.cern.ch/root/>.
-Install it by following the instructions included in Cint's
-distribution before trying to compile GiNaC-cint.  (See section
-`Working with the Cint C++ interpreter' below.)
-
 
 INSTALLATION
 ============
@@ -29,10 +22,10 @@ As with any autoconfiguring GNU software, installation is as easy as this:
  $ make
  $ make check
 [become root if necessary]
- $ make install
+ # make install
 
 Known to work with:
-  - Linux/x86, EGCS-1.1.x and GCC 2-95.x
+  - Linux on x86, Alpha and Sparc using GCC 2-95.x.
 Known not to work with:
   - GCC 2.7.x or earlier because proper exception support is missing there.
 
@@ -56,13 +49,13 @@ The time the "make" step takes depends heavily on optimization levels.
 Large amounts of memory (>128MB) will be required by the compiler,
 also depending on optimization.  To give you a rough idea of what you
 have to expect the following table may be helpful.  It was measured on
-a P-III/500MHz with "enough" memory:
+an Athlon/800MHz with "enough" memory:
 
-step:         | GCC optimization level:  | comment:
-              |  -O0   |  -O1   |  -O2   |
---------------+--------+--------+--------+-------------------------------
-make          |  ~4m   |  ~6m   |  ~10m  | building shared and static lib
-make check    |  ~3m   |  ~3m   |  ~7m   | mostly due to compilation
+step          | GCC optimization  | comment
+              |   -O1   |   -O2   |
+--------------+---------+---------+----------------------------------------
+make          |   ~6m   |   ~8m   | shared and static library
+make check    |   ~8m   |  ~12m   | largely due to compilation
 
 
 COMMON PROBLEMS
@@ -71,12 +64,11 @@ COMMON PROBLEMS
 Problems with CLN
 -----------------
 
-You should use at least CLN V1.0.3, since during the development of
+You should use at least CLN-1.1, since during the development of
 GiNaC various bugs have been discovered and fixed in earlier versions.
-To protect you, the "configure" script checks for a feature that was
-added in V1.0.3 so it won't continue with earlier versions anyhow.
 Please install CLN properly on your system before continuing with
-GiNaC.
+GiNaC.  When using GCC3 as compiler please use at least CLN-1.1.1
+since some parts of GiNaC won't build with CLN-1.1.
 
 Problems with building ginsh
 ----------------------------
@@ -88,27 +80,18 @@ libreadline and maybe libreadline-dev.  If your system's vendor
 doesn't supply such packages, go to <ftp://ftp.gnu.org/gnu/readline/>
 and compile it yourself.
 
-
-Working with the Cint C++ interpreter
-=====================================
-
-Please see <http://root.cern.ch/root/Cint.html> to learn about Cint
-and install it prior to installing ginaccint.  For the interpreter-
-compiler `makecint' to work properly, the Makefiles need to know where
-Cint has its system directory.  This is usually done by exporting
-$CINTSYSDIR to point to the proper place.  With GiNaC you may either
-try to export that variable and type
- $ ./configure --with-cint
-or specify it directly on the command line by saying
- $ ./configure --with-cint=/my/path/to/cintsysdir
-Enjoy!
-
-Here is an overview to gives you an idea if you can expect GiNaCcint 
-to compile, install and work properly:
-
- Cint version |   is known to work with   |  is known not to work with
---------------+---------------------------+-----------------------------
- < 5.14.37    |                           | (incompatible with GiNaC)
-   5.14.38    | egcs 1.1.1 (problematic)  | gcc.2.95.2
-   5.14.39    | egcs 1.1.1, gcc.2.95.2    | gcc <= 2.7.2.3
-   5.14.40    | egcs 1.1.1, gcc.2.95.2    | gcc <= 2.7.2.3
+Problems with missing standard header files
+-------------------------------------------
+
+Building GiNaC requires many standard header files.  If you get a
+configure error complaining about such missing files your compiler and
+library are probably not up to date enough and it's no worth
+continuing.  If the only file missing is <sstream>, however, there is
+a solution.  GCC-2.95.2 and earlier don't ship with this file.  A
+working implementation has been available since GCC-2.95.3.  GCC-3.0
+and later have an even better, fully standard-conforming
+implementation, by default.  If you are stuck with GCC-2.95.2 or
+earlier and you cannot upgrade your compiler we recommend obtaining
+the libstdc++-v2 <sstream> header written by Magnus Fromreide.  It was
+posted to the gcc-patches mailing list on November 21 2000:
+<http://gcc.gnu.org/ml/gcc-patches/2000-11/msg01152.html>.