On Thu, Apr 18, 2002 at 05:08:37PM +0200, Andreas Marcel Riechert wrote:
>  
> > What would a README file for mixin look like?
> You are the author, so you should know better, than me.
> Appart from the DESCRIPTION supplied by the Modules you
> could tell us
> 
> * Why you include Test::More, Test::Simple and Test::Build into
>   your distribution.

The reason I distribute them together is to minimize prerequisites.
If Test::More would be the module's only prereq, then I'll just
distribute it with it to keep installation simple.  If the module
already has other prereqs then I'll just make Test::More another
prereq.  Once you've got one prereq it doesn't really matter if you
have 2 or 5 or 10.  You're either using the CPAN shell or you're not.

But none of this is necessary knowledge to use or install the module.
If I've done my job right nobody should know I did it at all.


> ( I wonder how many different Test::More 's 
>   are distributed in "current Modules" via CPAN)

A lot.  CLASS.pm is still shipping with 0.09.  Doesn't matter how old
the a version is as long as each of them works well enough for that
specific module's tests.  Since the modules in t/lib/ don't get
installed it doesn't matter.


> * Why I should use your Module

That's covered in the DESCRIPTION.  mixin's is terse right now because
*I'm* still trying to figure out why I'd use my module.  And, in fact,
how mixins are supposed to work.

Since mixin is so experimental, let's use a more concrete and complete
example.  Exporter::Lite.


> Anyway, I think only the author of some Module will be able to
> produce an interesting README file.

Allow me to rephrase.  How would the README file be different from the
information that I already put in the NAME, SYNOPSIS and DESCRIPTION
sections?


-- 

Michael G. Schwern   <[EMAIL PROTECTED]>    http://www.pobox.com/~schwern/
Perl Quality Assurance      <[EMAIL PROTECTED]>         Kwalitee Is Job One
Summer sun beats down
I sigh and wait for winter
warm paste enemas.
        -- mjd

Reply via email to