==============================================
===            Introduction :               ==
==============================================
This directory contains the Generic Trace Generator (GTG) project.
Authors are : 
            Francois Rue    ,
            Francois Trahay ,
            Johnny   Jazeix ,
            Kevin    Coulomb,
            Mathieu  Faverge,
            Olivier  Lagrasse

==============================================
===                Files :                  ==
==============================================

-- Files
README        : This file, presenting the project
AUTHORS		  : The authors of the project
ChangeLog     : The list of the changes by version
configure.ac  : Used to create the configure file with autoreconf
COPYING		  : The copying rule
COPYRIGHT	  : The licence of the library
INSTALL		  : How to install the GTG library
Makefile.am	  : Some hints to generate the Makefile throught configure
NEWS		  : News about the project

-- Directories
*exm*         : Contains examples of programm using the library
*inc*         : Contains files to include
*src/C*       : Contains the C implementation of the API
*src/FORTRAN* : Contains the Fortran implementation of the API
*test*		  : Regular developers test



==============================================
===    Building from the Git repository:    ==
==============================================

First, you need to generate the configure files by running autoreconf:

$ autoreconf -vfi

Then, simply run configure && make && make install


==============================================
===               Examples :                ==
==============================================

The examples show code using the library.
You can compile them with *make examples*.
Their execution enables the creation of traces :
gtg_color creates the gtg_color.trace trace
cpaje     creates the cpaje.trace using the C API
fpaje     creates the fpaje.trace using the Fortran API
cpaje2    creates the cpaje2.trace using the C API
cvite     creates the cvite_root.ept trace (with cvite_proc*.ept) using the C API <DO NOT USE YET>

The traces can be viewed using the ViTE tool. This API is used by the eztrace
 that automatically generate traces for code, without modifying it manually.


==============================================
===               Support :                 ==
==============================================

If you encounter any problem, please fill an issue
(https://github.com/trahay/Generic-Trace-Generator/issues)
so that we can fix the feature as soon as possible.
You can also give us some feedback to help us improve the API.

