develooper Front page | perl.beginners | Postings from March 2002

Re: about the Readme file for CPAN modules

Thread Previous
From:
Elaine -HFB- Ashton
Date:
March 30, 2002 21:16
Subject:
Re: about the Readme file for CPAN modules
Message ID:
20020331051630.GX3494@chaos.wustl.edu
drieux [drieux@wetware.com] quoth:
*>
*>My concern is whether anyone here understands the stuff about
*>how to do a proper README file for a CPAN module - and I thought
*>i would ask folks who might know what they like and what is
*>just too much writing.

A README can be anything you like but most authors duplicate the POD from
their module in it or just have a brief description of the module. 

http://theoryx5.uwinnipeg.ca/CPAN/perl/pod/perlnewmod.html
http://cpan.valueclick.com/authors/id/H/HF/HFB/grok-cpan.pdf

may be helpful.

e.

Thread Previous


nntp.perl.org: Perl Programming lists via nntp and http.
Comments to Ask Bjørn Hansen at ask@perl.org | Group listing | About