...With a footnote to use nmake for Windows. To me, this is extremely useful information for the Perl beginner.With a footnote to use perl -V:make for your platform (no point in guessing).
perlnewmod says
Write the READMEIf you're uploading to CPAN, the automated gremlins will extract the README file and place that in your CPAN directory. It'll also appear in the main by-module and by-category directories if you make it onto the modules list. It's a good idea to put here what the module actually does in detail, and the user-visible changes since the last release.
Should this information appear somewhere in the pod, perhaps under =head1 INSTALLATION? Is it something that we all take for granted anyway? Maybe it belongs in a separate file called INSTALL.That information should never be in the pod. Its not useful once the module is installed. If a user knows enough to read the pod, he knows enough to read a README or INSTALL file.
Maybe it belongs in a separate file called INSTALL.There's no need for a separate INSTALL file unless the installation procedure is more involved (for example http://search.cpan.org/dist/Wx/docs/INSTALL.pod).
In reply to Re: What should be in the README for a module?
by PodMaster
in thread What should be in the README for a module?
by rinceWind
| For: | Use: | ||
| & | & | ||
| < | < | ||
| > | > | ||
| [ | [ | ||
| ] | ] |