in reply to CPAN and module dependancies
CPAN.org already provides the README for every module, and that info should be in the README, as detailed as an author wants it to be. See:
E:\new>h2xs -AX Foo::Bar Writing Foo/Bar/Bar.pm Writing Foo/Bar/Makefile.PL Writing Foo/Bar/README Writing Foo/Bar/test.pl Writing Foo/Bar/Changes Writing Foo/Bar/MANIFEST E:\new>more "Foo/Bar/README" Foo/Bar version 0.01 ==================== 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: blah blah blah COPYRIGHT AND LICENCE Put the correct copyright and licence information here. Copyright (C) 2002 A. U. Thor This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
____________________________________________________
** The Third rule of perl club is a statement of fact: pod is sexy.
|
|---|