]> www.ginac.de Git - ginac.git/blobdiff - INSTALL
Consider solve_algo::markowitz in automatic elimination algorithm selection.
[ginac.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index b542d9e647d331a1b6b4c46dd836da129243a09f..75b8446614be0c5ee021b1a65ad475e49dc65643 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -2,41 +2,39 @@ PREREQUISITES
 =============
 
 GiNaC requires the CLN library by Bruno Haible installed on your system.
-It is available from <ftp://ftpthep.physik.uni-mainz.de/pub/gnu/>.
+It is available from <http://www.ginac.de/CLN/>.
 
-You will also need a decent ANSI-compliant C++-compiler. We recommend the
-C++ compiler from the GNU compiler collection, GCC >= 3.4. If you have a
+You will also need a decent ISO C++-11 compiler. We recommend the C++
+compiler from the GNU compiler collection, GCC >= 4.8. 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.
 
 The pkg-config utility is required for configuration, it can be downloaded
-from <http://pkg-config.freedesktop.org/>.
+from <http://pkg-config.freedesktop.org/>. Also Python version >= 2.6 is
+required.
 
 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:
- - 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)
+ - Linux on x86 and x86_64 using
+   - GCC 4.8, 4.9, 5.1, 5.2, 5.3, and 6.1
+   - Clang 3.5, 3.6, 3.7, 3.8
 
 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.
+ - Clang 2.7 and earlier due to poor C++ support.
+ - GCC < 4.6.0 due to missing C++-11 support
 
-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), python (>= 2.5), bison (>= 2.3), flex (>= 2.5.33) to be installed.
 
 
 INSTALLATION
 ============
 
-To install from a source .tar.bz2 distribution:
+To install from an unpacked source .tar.bz2 distribution:
 
  $ ./configure
  $ make
@@ -73,28 +71,19 @@ A few of the more important ones:
 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 an Athlon/800MHz with
-"enough" memory:
+The time to build the library depends to a large degree on optimization levels.
+Using the default high optimization, 'make' takes a few minutes on a fast
+machine and 'make check' takes some more minutes. You can speed this up with a
+parallel build with 'make -j2' or higher, depending on the number of available
+CPU cores.
 
-step          | GCC optimization  | comment
-              |   -O1   |   -O2   |
---------------+---------+---------+----------------------------------------
-make          |   ~6m   |   ~8m   | shared and static library
-make check    |   ~8m   |  ~12m   | largely due to compilation
 
-
-To install from CVS
+To install from git 
 ===================
 
 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
@@ -118,7 +107,7 @@ COMMON PROBLEMS
 Problems with CLN
 -----------------
 
-You should use at least CLN-1.1, since during the development of GiNaC
+You should use at least CLN-1.2.2, since during the development of GiNaC
 various bugs have been discovered and fixed in earlier versions. Please
 install CLN properly on your system before continuing with GiNaC.