-*- text -*-

//=======================================================================
// Copyright 1997, 1998, 1999, 2000 University of Notre Dame.
// Authors: Andrew Lumsdaine, Lie-Quan Lee, Jeremy G. Siek
//
// This file is part of the Generic Graph Component Library
//
// You should have received a copy of the License Agreement for the
// Generic Graph Component Library along with the software;  see the
// file LICENSE.  If not, contact Office of Research, University of Notre
// Dame, Notre Dame, IN  46556.
//
// Permission to modify the code and to distribute modified code is
// granted, provided the text of this NOTICE is retained, a notice that
// the code was modified is included with the above COPYRIGHT NOTICE and
// with the COPYRIGHT NOTICE in the LICENSE file, and that the LICENSE
// file is distributed with the modified code.
//
// LICENSOR MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED.
// By way of example, but not limitation, Licensor MAKES NO
// REPRESENTATIONS OR WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY
// PARTICULAR PURPOSE OR THAT THE USE OF THE LICENSED SOFTWARE COMPONENTS
// OR DOCUMENTATION WILL NOT INFRINGE ANY PATENTS, COPYRIGHTS, TRADEMARKS
// OR OTHER RIGHTS.
//=======================================================================

---------------------------------------------------------------

              The Generic Graph Component Library
                    Version 2.0.1

I. GGCL Installation
=================

0. unpack from the tar ball:

   gzip -cd ggcl-2.0.1-x.tar.gz |tar xvf -


From the top level directory of ggcl:

1. Set the CXX environment variable to your compiler.

csh:
  setenv CXX KCC   (or g++)
sh:
  CXX=KCC
  export CXX
ksh:
  export CXX=KCC

2. Run the configure script

./configure [options]

Where options can include:

--prefix=dir
  The header files of GGCL will be copied into this directory,
  placed under a /ggcl directory.

The next step is to do:

make install

which will copy the GGCL header files to the install directory.  Unlike
most software libraries, there is not an GGCL library file (no
libggcl.a). All of the GGCL functionality is in the GGCL headers
and one just needs to #include them.

JGS, talk about making the examples...


II. Using GGCL
=============

The code resides completely in header files, so it is not necessary to
compile a library and link it into your executable. Just include the
GGCL header files you need.

see our ggcl homepage at http://lsc.nd.edu/research/ggcl for
documentation and other information.

III. High Performance
=====================

To get high performance with GGCL you must use a good optimizing compiler,
such as KAI's C++. You must also use the right compilation flags.
We recommend:

+K2 --inline_keyword_space_time=10000 --no_exceptions

(+K3 is the highest possible optimization flags. However, KCC with +K3
generates wrong code for breadth_first_search under Solaris.) 
and the flags are needed for the backend compiler such as:

-fast


Note: 

The gcc 2.95.x does not make enough optimizations for GGCL to be
fast.

