- changed behaviour of numeric::is_rational() and added numeric::is_cinteger()
[ginac.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index 750d5164c0a134a983143513b0b0fd2d407750aa..9dba753cf3119f8bb7c6f617a59e6e3db936b7bd 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,25 +1,58 @@
-Installation:
+Prerequisites
 =============
 
+GiNaC requires the CLN library by Bruno Haible, available at
+<ftp://ftp.santafe.eu/pub/gnu/> or <ftp://ftp.ilog.fr/pub/Users/haible/gnu/>.
+You will also need a good C++ compiler adhering to the ANSI standard (we 
+used gcc for development so if you have a different compiler you are on 
+your own).
+
+
+Installation
+============
+
 As with any autoconfiguring GNU software, installation is as easy as this:
 
-sysprompt> ./configure
-sysprompt> make
-sysprompt> make check
-sysprompt> make install
+ $ ./configure
+ $ make
+ $ make check
+[become root if necessary]
+ $ make install
 
 Known to work with:
-  - Linux/x86, EGCS-1.1.2 or GCC 2-95.
+  - Linux/x86, EGCS-1.1.2 or GCC 2-95.1/2-95.2
+
+The "configure" script can be given a number of options to enable and
+disable various features. For a complete list, type:
 
-The "make" step takes about 10 minutes, on a 586 DX / 133 MHz / 64 MB or
-about 2 minutes on a P-III /550 MHz / 512 MB.
+ $ ./configure --help
+
+A few of the more important ones:
+
+ --prefix=PREFIX        install architecture-independent files in PREFIX
+                        [defaults to /usr/local]
+ --exec-prefix=EPREFIX  install architecture-dependent files in EPREFIX
+                        [defaults to the value given to --prefix]
+ --disable-shared       suppress the creation of a shared version of libginac
 
 More detailed installation instructions can be found in the documentation,
 in the doc/ directory.
 
+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:
+
+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
+
 
-Problems with CLN:
-==================
+Problems with CLN
+=================
 
 You should use at least CLN V1.0.2, since all earlier ones are
 somewhat buggy.  Even V1.0.1 has a few problems and GiNaC will not