check: indicate the test failures with non-zero exit code; split test programs.

[ginac.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index 038ae7629cd8c69607701ab77c35df6b1c1c3800..38b9681eac6fdec462e136cc9af4a8a3969e6887 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -10,13 +10,23 @@ 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.
 
 use the same compiler you compiled CLN with because of differing
 name-mangling schemes.
 

+The pkg-config utility is required for configuration, it can be downloaded
+from <http://pkg-config.freedesktop.org/>.
+
+To build the GiNaC tutorial and reference manual the doxygen utility
+(it can be downloaded from http://www.stack.nl/~dimitri/doxygen) and
+TeX are necessary.
+

 Known to work with:
 Known to work with:

- - Linux on x86, Alpha and Sparc using GCC 3.0.x, 3.1 and 3.2.
+ - Linux on x86, Alpha and Sparc using GCC 3.x and 4.0.

 
 Known not to work with:
  - GCC 2.96 or earlier because proper exception and standard library support
    is missing there.
 
 
 Known not to work with:
  - 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.
+

 
 INSTALLATION
 ============
 
 INSTALLATION
 ============


@@ -28,17 +38,6 @@ To install from a source .tar.bz2 distribution:
  [become root if necessary]
  # make install
 
  [become root if necessary]
  # make install
 

-To install from CVS:
-
- $ cvs -d :pserver:anoncvs@cvsthep.physik.uni-mainz.de:/home/cvs login
- [enter "anoncvs" as the password]
- $ cvs -d :pserver:anoncvs@cvsthep.physik.uni-mainz.de:/home/cvs co GiNaC
- $ cd GiNaC
- $ ./autogen.sh
- $ make
- [become root if necessary]
- # make install
-

 To build the GiNaC tutorial and reference manual in HTML, DVI, PostScript,
 or PDF formats, use one of
 
 To build the GiNaC tutorial and reference manual in HTML, DVI, PostScript,
 or PDF formats, use one of
 


@@ -52,9 +51,8 @@ library works correctly you can use
 
  $ make check
 
 
  $ make check
 

-The "configure" script (and "autogen.sh", which invokes "configure") can be
-given a number of options to enable and disable various features. For a
-complete list, type:
+The "configure" script can be given a number of options to enable and
+disable various features. For a complete list, type:

 
  $ ./configure --help
 
 
  $ ./configure --help
 


@@ -83,6 +81,32 @@ 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
+===================
+
+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
+
+Secondly, make sure all required software is installed. This is *really*
+important step. If some package is missing, the `configure' script might
+be misgenerated, see e.g. this discussion:
+<http://www.ginac.de/pipermail/ginac-list/2007-November/001263.html>
+
+Finally, run
+
+ $ autoreconf -i
+
+to generate the `configure' script, and proceed in a standard way, i.e.
+
+ $ ./configure
+ $ make
+ [become root if necessary]
+ # make install
+

 COMMON PROBLEMS
 ===============
 
 COMMON PROBLEMS
 ===============
 


@@ -96,12 +120,13 @@ 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
+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
 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.
+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
 -------------------------------------------
 
 Problems with missing standard header files
 -------------------------------------------