
  CFL - Configuration File Library
  $Id: README,v 1.2 2002/08/26 17:18:40 ndarnis Exp $
  ____________________________________________________________________

  This is the entry point of the CFL project.

  1. FILES

    Read the COPYING file for license terms.

    Read the INSTALL file to learn about how to install CFL on your
    operating system.

    Read the ChangeLog file for detailed changes informations between 
    files releases.

    Read the NEWS file for news about latest CFL versions.

    Read the AUTHORS file for list of authors who have highly 
    contributed to this projet.

  2. DOCUMENTATION

    The doc/ directory contains the CFL documentations:

    - doc/man/ contains the CFL reference manual as man pages 
      (automatically installed by the installation process)
    - doc/ref/ contains the CFL reference into HTML format
      (not installed by the installation process)

  3. INSTALLATION

    IMPORTANT NOTE: this project needs the GDSL library installed
    on your system to work. You could find GDSL at the following
    site: http://www.freesoftware.fsf.org/gdsl/.
    
    Read INSTALL file for standard installation instructions.

  4. USAGE

     Simply include '#include <cfl.h>' into your source C file. You
     should modify your include directory path to point to the one 
     you have installed the CFL header file
     ('/usr/local/include/' by default).
     Include '-lcfl' to your link command, and add the lib dir to 
     your Makefile ('/usr/local/lib/' is the default location).

     You'll find an example programm in 'src/example.c' to show a
     sample usage of CFL capabilities.

     Then, you can use any of the functions described in the main CFL
     header file: 'cfl.h'.


  Happy Hacking!                                       Nicolas Darnis.
