- Updated note about how to compile with Cint.

[ginac.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index 4555857e83d9bc7f4afb3f18a8febb96bd3da2d5..c47aa470fa4b97de16adcaa809e8226d2e52631c 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,4 +1,4 @@
-Prerequisites
+PREREQUISITES
 =============
 
 GiNaC requires the CLN library by Bruno Haible, available at either
@@ -21,7 +21,7 @@ distribution before trying to compile GiNaC-cint.  (See section
 `Working with the Cint C++ interpreter' below.)
 
 
-Installation
+INSTALLATION
 ============
 
 As with any autoconfiguring GNU software, installation is as easy as this:
@@ -33,7 +33,7 @@ As with any autoconfiguring GNU software, installation is as easy as this:
  $ make install
 
 Known to work with:
-  - Linux/x86, EGCS-1.1.2 or GCC 2-95.1/2-95.2
+  - Linux/x86, EGCS-1.1.x and GCC 2-95.x
 
 The "configure" script can be given a number of options to enable and
 disable various features. For a complete list, type:
@@ -61,11 +61,14 @@ step:         | GCC optimization level:  | comment:
               |  -O0   |  -O1   |  -O2   |
 --------------+--------+--------+--------+-------------------------------
 make          |  ~4m   |  ~6m   |  ~10m  | building shared and static lib
-make check    |  ~2m   |  ~2m   |  ~7m   | mostly due to compilation
+make check    |  ~3m   |  ~3m   |  ~7m   | mostly due to compilation
 
 
+COMMON PROBLEMS
+===============
+
 Problems with CLN
-=================
+-----------------
 
 You should use at least CLN V1.0.3, since during the development of
 GiNaC various bugs have been discovered and fixed in earlier versions.
@@ -74,10 +77,39 @@ 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.
 
+Problems with building ginsh
+----------------------------
+
+The most common reason why this doesn't succeed is the absence of
+libreadline and/or the corresponding header files.  Depending on what
+your system/distribution is, you will have to install a package called
+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.  After that it should work fine.  
+
+If you want to build a completely static ginsh and your compiler still
+complains about unresolved objects try linking with libncurses, too.
+
 
 Working with the Cint C++ interpreter
 =====================================
 
-You need to specify
-  --with-cint=$CINTSYSDIR
-...
+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