This README file is part of the ECO distribution. (last update November 28, 1997)
(pizzonia@inf.uniroma3.it)


TABLE OF CONTENTS
=================

  0. What is ECO?
     0.1 Copyright terms.
  1. Distribution contents
  2. Installation
    2.1 On which systems it runs?
    2.2 Procedure
    2.3 PROBLEMS & SOLUTIONS


0. What is ECO?
===============

From a practical point of view ECO is a precompiler for GNU G++ that
extends the C++ language with new powerful constructs. A description of
the theoretical motivation can be found at:
http://www.inf.uniroma3.it/~pizzonia/eco.

The new constructs make easier writing large libraries dealing with
complex combinatorial structures that change dynamically (like
graphs).


0.1 Copyright terms
-------------------

This software can be used free of charge in academic research and
teaching. Any direct or indirect commercial use of this software is
illegal without a written authorization of the Dipartimento di
Informatica e Automazione, Universita' di Roma Tre, Roma, ITALIA.



1. Distribution contents
========================

The following is the the directory tree of the ECO installation:
   
   README: this file

   GD/     a directory containing sources to generate a demo application.

               A little library of classes for dealing with graphs and
               performing layout (based on the Sugiyama algorithm).
               They show an interesting way to handle fictitious vertices,
               using extenders.

               A simple graph editor written in Tcl/Tk and using the above 
               mentioned library. It permits to manage more than one drawing
               and more than one orientation. Sugiyama based layout is supported. 

               Great flexibility is achieved in choosing different orientations 
               for the execution of Sugiyama algorithm and for visualization.

   doc_html/  a directory containing the HTML documentation available at the
              web site.

   eco_prec/  a directory containign sources to generate the 
              precompiler (eco_prec) for ECO C++




  
2. Installation 
===============


2.1 On which systems it runs?
-----------------------------

    At present it strictly require UNIX and GNU G++. It has been
tested on the following platforms:

       Hardware          Operative System
       --------          ----------------
       PC                Linux
       Sun Ultra 1       Solaris
       IBM RS6000        AIX
       Digital DEC       OSF1

The used version of GNU G++ was 2.7.2. To compile and use the demo
application Tcl/Tk must be installed.
I think that it can likely run on other platforms with minor changes in the code.



2.2 Procedure
-------------

Download the file eco.tar.gz from the eco's site
(http://www.inf.uniroma2.it/~pizzonia/eco). Extract the ECO directory
tree from it using:

   gunzip eco.tar.gz
   tar -xvf eco.tar

It will create a directory 'eco' including all sources and makefiles.
To build the precompiler use:

   cd eco/eco_prec
   make
   cd ..     # this leave you in the root of the eco directory tree 

It will produce an executable "eco_prec". Make it reachable as a
command updating the PATH variable or creating a link to it.
To build the demo application use

   cd GD
   make

It will produce an executable "demo".



2.3 PROBLEMS & SOLUTIONS
------------------------

Remember "eco_prec" must be reachable from PATH to build the demo
application.

Try to use "gmake" instead of "make".  The makefiles are tested using
GNU MAKE. On many system typing "make" run the proprietary make
program. GNU MAKE is often called "gmake".

Check makefiles for libraries names and include locations.