Read Me

Welcome to errdef.

errdef is free software. Please see the file COPYING for details.
For documentation, please see the files in the doc subdirectory.
For building and installation instructions please see the INSTALL file.

ABOUT ERRDEF

ERRDEF is a tool designed to be used in development environments, as a build
rule, to generate files to be included in code projects. The files include a
definitions file, that define symbols with numeric values (such as #define's
in C/C++), and, optionally, a code file with facilities to perform a lookup
of a certain value in order to get the associated symbolic name as a string,
and to get a description string if it was provided.

As an example, in a project written in C, there could be a definitions file
(input to errdef) that defines many codes, recursively, without specifying
any values for the codes. ERRDEF would then generate the .h and .c files
that list the codes and that perform the lookup. These files would then be
compiled into the application.

The project's homepage is at http://sourceforge.net/projects/errdef/