X-Git-Url: https://www.ginac.de/CLN/cln.git//cln.git?a=blobdiff_plain;f=INSTALL;h=8eca4fdc583750b8368f9718d51bb22f79bd19b5;hb=ba2ba754a5f378983764cdb3dfeceea1ec1ba596;hp=5592eb603eaa26806e68a8745f779b5b9703bd6a;hpb=154648c016022332e71929c160cb8e66bbaf1e97;p=cln.git

diff --git a/INSTALL b/INSTALL
index 5592eb6..8eca4fd 100644
--- a/INSTALL
+++ b/INSTALL
@@ -1,40 +1,118 @@
-Installation:
+Prerequisites.
 =============
 
-As with any autoconfiguring GNU software, installation is as easy as this:
+ANSI-compliant C++ compiler. GNU C++ compiler (version >= 3.4) is recommend.
+Non-GNU compilers might not work at the moment.
+
+GNU multiprecision library (http://gmplib.org), version > 4.0 (older 3.x
+versions might work too).
+
+[Optional] To build CLN documentation texinfo and TeX are necessary.
+
+If you install CLN from git, you also need 
+
+git itself (http://git.or.cz), version >= 1.5.0
+GNU autoconf (http://www.gnu.org/software/autoconf), version >= 2.59
+GNU libtool  (http://www.gnu.org/software/libtool), version >= 1.5
+GNU automake (http://www.gnu.org/software/automake), version >= 1.8
+
+Installation from a source .tar.bz2 distribution.
+================================================
 
 $ ./configure
 $ make
 $ make check
-$ make install
+[ become root if necessary ]
+# make install
+
+To build the manual in PDF, HTML, or PostScript formats, use one of
+
+$ make pdf
+$ make html
+$ make ps
+
+To compile and run CLN's test suite and check whether the library was
+compiled correctly you can use
+
+$ make check
+
+The "configure" script can be given a number of options to enable and
+disable various features. Most useful ones are:
+
+--prefix=DIR
+
+Install CLN into the directory DIR (default: /usr/local).
+
+--with-gmp
+
+Use GNU multiprecision library (default: yes, if available)
 
-You need GNU make. On HP-UX, you also need GNU sed.
+--disable-static
 
-Known to work with:
-  - Linux/x86, gcc-2.7.0, gcc-2.7.2, gcc-2.8.0, egcs-1.1, gcc-2.95
-  - Solaris 2.4 (sparc), gcc-2.7.0, gcc-2.7.2, egcs-1.1, gcc-2.95
-  - OSF/1 V4.0 (alpha), egcs-1.1, gcc-2.95
-  - Irix 5.3, CC 4
+Don't build static version of CLN library. This option is useful if
+want to reduce the build time (and you don't need the static library).
 
-The "make" step takes about 4 hours, on a 486 DX / 33 MHz / 8 MB.
+For a complete list, run:
+
+$ ./configure --help
+
+
+Installation from git.
+=====================
+
+1. Download the code.
+
+Initial download:
+
+$ git clone git://www.ginac.de/cln.git
+
+Later on you can update your copy with
+
+$ git pull
+
+2. Make sure all required software is installed. This is *really*
+important step. If some package is missing, the `configure' script might
+be misgenerated,
+
+3. Run
+
+$ autoreconf -iv
+
+to generate the `configure' script, and proceed in a standard way, i.e.
+
+$ ./configure
+$ make
+[become root if necessary]
+# make install
 
-On Linux, g++ needs 15 MB to compile the tests. So better have
-17 MB swap space and 1 MB room in $TMPDIR.
+CLN is known to work with:
+=========================
 
-If you use gcc and g++ version 2.7.x, don't add -O2 to the CXXFLAGS, because
-"g++ -O" generates better code for libcln.a than "g++ -O2".
+  - Linux/x86, gcc-3.x, gcc-4.[0-5].x
+  - Linux/x86_64, gcc-3.[3-4], gcc-4.[0-6].x, clang-2.8
+  - Linux/ia64, gcc-3.[2-4], gcc-4.[0-4].x
+  - Linux/arm, gcc-3.[0-3] (*), gcc-4.[0-4].x (*)
+  - Linux/mips, gcc-3.3, gcc-4.[0-4].x
+  - Linux/sparc, gcc-3.[1-3], gcc-4.[0-2].x
+  - Linux/alpha, gcc-3.[0-3], gcc-4.[0-2].x
+  - Linux/powerpc, gcc-3.[0-3], gcc-4.[0-4].x
+  - Linux/hppa, gcc-4.2.x (*)
+  - Solaris 2.4 (sparc), gcc-3.[1-3], gcc-4.[0-2].x (*)
+  - OSF/1 V4.0 (alpha), gcc-3.1
+  - Irix 6.5, gcc-3.0
+  - OS X Leopard (x86), gcc 4.0.1
+  - Windows/32-bit, MSVC 16.00.30319.01
 
-If you use g++ version 2.8.x or egcs-2.91.x (a.k.a. egcs-1.1) or gcc-2.95.x,
-I recommend adding "-fno-exceptions" to the CXXFLAGS. This will likely
-generate better code.
+(*) On these platforms, problems with the assembler routines have been
+reported. It may be best to add "-DNO_ASM" to CPPFLAGS before
+configuring.
 
-If you use g++ version egcs-2.91.x (egcs-1.1) or gcc-2.95.x on Sparc, add
-either "-O" or "-O2 -fno-schedule-insns" to the CXXFLAGS. With full "-O2",
-g++ miscompiles the division routines. Also, for --enable-shared to work, you
-need egcs-1.1.2 or newer.
+Using gcc-4.2, the "make" step takes about 15 minutes, on an x86_64 / 2 GHz.
 
-On MIPS (SGI Irix 6), pass option "--without-gmp" to configure. gmp does
-not work when compiled in "n32" binary format on Irix.
+If you use g++ from gcc-3.0.4 or older on Sparc, add either "-O", "-O1" or
+"-O2 -fno-schedule-insns" to the CXXFLAGS. With full "-O2", g++ miscompiles
+the division routines. Do not use gcc-3.0 on Sparc for compiling CLN, it
+won't work at all.
 
 More detailed installation instructions can be found in the documentation,
 in the doc/ directory.