Adjusted NEWS and INSTALL documentation.

[ginac.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index 38b9681eac6fdec462e136cc9af4a8a3969e6887..de7ba244a79f62496e6e3eb038590b622237aacb 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -5,7 +5,7 @@ GiNaC requires the CLN library by Bruno Haible installed on your system.
 It is available from <ftp://ftpthep.physik.uni-mainz.de/pub/gnu/>.
 
 You will also need a decent ANSI-compliant C++-compiler. We recommend the
 It is available from <ftp://ftpthep.physik.uni-mainz.de/pub/gnu/>.
 
 You will also need a decent ANSI-compliant C++-compiler. We recommend the

-C++ compiler from the GNU compiler collection, GCC >= 3.0. If you have a
+C++ compiler from the GNU compiler collection, GCC >= 3.4. If you have a

 different or older 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.
 different or older 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.


@@ -18,14 +18,20 @@ To build the GiNaC tutorial and reference manual the doxygen utility
 TeX are necessary.
 
 Known to work with:
 TeX are necessary.
 
 Known to work with:

- - Linux on x86, Alpha and Sparc using GCC 3.x and 4.0.
+ - Linux on x86 and x86_64 using GCC 3.4, 4.0, 4.1, and 4.2.
+ - Linux on Alpha using GCC 3.4.
+ - Solaris on Sparc using GCC 3.4.
+ - Windows on x86 using GCC 3.4 (MinGW)

 
 Known not to work with:
 
 Known not to work with:

+ - GCC 4.3.0 due to the compiler bug,
+   see <http://gcc.gnu.org/bugzilla/show_bug.cgi?id=35548>.

  - GCC 2.96 or earlier because proper exception and standard library support
    is missing there.
 
  - GCC 2.96 or earlier because proper exception and standard library support
    is missing there.
 

-If you install from CVS, you also need GNU autoconf (>=2.59), automake (>=1.7),
-libtool (>= 1.5), bison (>= 2.3), flex (>= 2.5.33) to be installed.
+If you install from git, you also need GNU autoconf (>=2.59), automake (>=1.8),
+libtool (>= 1.5), bison (>= 2.3), flex (>= 2.5.33), autogen (>= 5.6.0) to be
+installed.

 
 
 INSTALLATION
 
 
 INSTALLATION


@@ -81,15 +87,12 @@ make          |   ~6m   |   ~8m   | shared and static library
 make check    |   ~8m   |  ~12m   | largely due to compilation
 
 
 make check    |   ~8m   |  ~12m   | largely due to compilation
 
 

-To install from CVS
+To install from git 

 ===================
 
 First, download the code:
 ===================
 
 First, download the code:

-
- $ cvs -d :pserver:anoncvs@cvs.ginac.de:/home/cvs/GiNaC login
- [enter "anoncvs" as the password]
- $ cvs -d :pserver:anoncvs@cvs.ginac.de:/home/cvs/GiNaC co GiNaC
- $ cd GiNaC
+ $ git clone git://www.ginac.de/ginac.git ginac
+ $ cd ginac

 
 Secondly, make sure all required software is installed. This is *really*
 important step. If some package is missing, the `configure' script might
 
 Secondly, make sure all required software is installed. This is *really*
 important step. If some package is missing, the `configure' script might


@@ -120,12 +123,21 @@ install CLN properly on your system before continuing with GiNaC.
 Problems building ginsh
 -----------------------
 
 Problems building ginsh
 -----------------------
 

-The most common reason why this doesn't succeed is the absence of GNU
-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. Note that non-GNU versions of libreadline (in particular
+The GiNaC interactive shell, ginsh, makes use of GNU readline to provide 
+command line editing and history. If readline library and/or headers are
+missing on your system, the configure script will issue a warning. In this
+case you have two options:
+
+1) (the easiest) If you don't intend to use ginsh (i.e. if you need GiNaC
+library to compile some piece of software), ignore it. ginsh builds just
+fine without readline (obviously, it won't support the command line history
+and editing).
+
+2) Install GNU readline and run the configure script once again. Depending on
+what your system/distribution is, you will have to install a package called
+libreadline and libreadline-dev (or readline-devel). If your system's vendor
+doesn't supply such packages, go to <ftp://ftp.gnu.org/gnu/readline/> and
+compile it yourself. Note that non-GNU versions of libreadline (in particular

 one shipped with Mac OS X) are not supported at the moment.
 
 Problems with missing standard header files
 one shipped with Mac OS X) are not supported at the moment.
 
 Problems with missing standard header files