Re: [Module::Build] mb advice in CPAN READMEs

[David G. <da...@hy...>]

Dr Bean wrote:
> Is there any accepted way of explaining Module::Build in the
> READMEs of modules whose installation requires it?
> 
> This is what I said with one with a passthrough Makefile.PL, but
> perhaps I could have refered to something that explained
> procedures in more detail.

First, I suggest using 'traditional' instead of 'passthrough' for your 
Makefile.PL, unless you're doing something unusual in the Build.PL that 
really demands only a Module::Build solution.  You'll make life a lot 
easier for those who don't have Module::Build installed and don't want 
to (or can't) install it.

Second, to your question, I've started to use something very similar -- 
though it's almost equally minimal.  Since most modules get installed 
via CPAN, PPM, or a distro package, I don't think the installation 
instructions are a great place to spend a lot of effort.  Here's mine:

> INSTALLATION 
> 
> If Module::Build is installed (preferred):
> 
>     perl Build.PL
>     perl Build
>     perl Build test
>     perl Build install
> 
> Otherwise, using a Makefile:
> 
>     perl Makefile.PL
>     make
>     make test
>     make install
> 
> If you are on a windows box you should use 'nmake' rather than 'make'.
> 

Regards,
David Golden