
  CFL - Configuration File Library
  $Id: README,v 1.5 2003/05/28 09:18:17 ndarnis Exp $
  ____________________________________________________________________

  Introduction
  ============

  The Configuration File Library (CFL) is a collection of routines for 
  manipulating configuration files. It is a portable library fully 
  written from scratch in pure ANSI C. It is designed to offer for C 
  programmers common routines for manipulating configuration text files. 

  CFL is free software, you can redistribute it and/or modify it under
  the terms of the GNU General Public License.

  The GNU General Public License does not permit this software to be
  redistributed in proprietary programs.

  This library is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

  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 changes information betwwen CFL releases.

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

  Read the TODO file to see work planed for futures versions.

  Documentation
  =============

  The doc/ directory contains the documentations:

  - The file grammar.txt describe accepted CFL files format.
  - man/ contains the reference manual as man pages.
  - ref/html contains the reference manual as HTML files.

  Installation
  ============

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

  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.
