The README is used to introduce the module and provide instructions on how to install the module, any machine dependencies it may have (for example C compilers and installed libraries) and any other information that should be provided before the module is installed.
A README file is required for CPAN modules since CPAN extracts the README file from a module distribution so that people browsing the archive can use it get an idea of the modules uses. It is usually a good idea to provide version information here so that people can decide whether fixes for the module are worth downloading.
INSTALLATION
To install this module type the following:
perl Makefile.PL
make
make test
make install
DEPENDENCIES
This module requires these other modules and libraries:
Data::Dumper
Data::Compare
String::Escape
COPYRIGHT AND LICENCE
Put the correct copyright and licence information here.
Copyright (C) 2001 Kurt Stephens and ION, Inc.
REVISION
$Id: README,v 1.3 2002/04/22 06:36:58 stephens Exp $