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 to get an idea of the module's 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.
To install this module, run the following commands:
perl Makefile.PL make make test make install
SUPPORT AND DOCUMENTATION
After installing, you can find documentation for this module with the perldoc command.
You can also look for information at:
RT, CPAN's request tracker
AnnoCPAN, Annotated CPAN documentation
COPYRIGHT AND LICENCE
Copyright (C) 2009 Zane C. Bowers
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.