[Module-build-checkins] Module-Build/lib/Module/Build Authoring.pod,1.9,1.10
Status: Beta
Brought to you by:
kwilliams
|
From: Ken W. <kwi...@us...> - 2005-07-08 01:43:41
|
Update of /cvsroot/module-build/Module-Build/lib/Module/Build In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv17475/lib/Module/Build Modified Files: Authoring.pod Log Message: Update the info about generated README files Index: Authoring.pod =================================================================== RCS file: /cvsroot/module-build/Module-Build/lib/Module/Build/Authoring.pod,v retrieving revision 1.9 retrieving revision 1.10 diff -u -d -r1.9 -r1.10 --- Authoring.pod 5 May 2005 17:20:39 -0000 1.9 +++ Authoring.pod 8 Jul 2005 01:43:32 -0000 1.10 @@ -200,11 +200,16 @@ This parameter tells Module::Build to automatically create a F<README> file at the top level of your distribution. Currently it will simply -use C<Pod::Text> on the file indicated by C<dist_version_from> and put +use C<Pod::Text> (or C<Pod::Readme> if it's installed) on the file +indicated by C<dist_version_from> and put the result in the F<README> file. This is by no means the only recommended style for writing a README, but it seems to be one common one used on the CPAN. +If you generate a F<README> in this way, it's probably a good idea to +create a separate F<INSTALL> file if that information isn't in the +generated F<README>. + =item dist_abstract This should be a short description of the distribution. This is used |