Acme-CreatingCPANModules

 view release on metacpan or  search on metacpan

README  view on Meta::CPAN

Acme-CreatingCPANModules

The README is used to introduce the module and provide instructions on
how to install the module, any machine dependencies it may have (for
example C compilers and installed libraries) and any other information
that should be provided before the module is installed.

A README file is required for CPAN modules since CPAN extracts the README
file from a module distribution so that people browsing the archive
can use it get an idea of the modules uses. It is usually a good idea
to provide version information here so that people can decide whether
fixes for the module are worth downloading.

INSTALLATION

To install this module, run the following commands:

    perl Makefile.PL

slides/slide16.html  view on Meta::CPAN

<!-- END top -->

<div id="content">
<div class="top_spacer"></div>

<h1>t/pod-coverage.t</h1>
<pre class="formatter_pre">#!perl -T

use Test::More;
eval &#34;use Test::Pod::Coverage 1.04&#34;;
plan skip_all =&gt; &#34;Test::Pod::Coverage 1.04 required for testing POD coverage&#34; if $@;
all_pod_coverage_ok&#40;&#41;;
</pre>

</div>
<!-- BEGIN bottom -->
<div id="bottombar">
<table width="100%">
<tr>
<td align="left" valign="middle">
    <div style="display:none">

slides/slide17.html  view on Meta::CPAN

<!-- END top -->

<div id="content">
<div class="top_spacer"></div>

<h1>t/pod.t</h1>
<pre class="formatter_pre">#!perl -T

use Test::More;
eval &#34;use Test::Pod 1.14&#34;;
plan skip_all =&gt; &#34;Test::Pod 1.14 required for testing POD&#34; if $@;
all_pod_files_ok&#40;&#41;;
</pre>

</div>
<!-- BEGIN bottom -->
<div id="bottombar">
<table width="100%">
<tr>
<td align="left" valign="middle">
    <div style="display:none">

slides/slide4b.html  view on Meta::CPAN

<div id="content">
<div class="top_spacer"></div>

<h1>With Module::Starter</h1>
<pre class="formatter_pre">$ module-starter 
Usage:
    module-starter [options]

    Options:

        --module=module  Module name &#40;required, repeatable&#41;
        --distro=name    Distribution name &#40;optional&#41;
        --dir=dirname    Directory name to create new module in &#40;optional&#41;

        --builder=module Build with &#39;ExtUtils::MakeMaker&#39; or &#39;Module::Build&#39;
        --eumm           Same as --build=ExtUtils::MakeMaker
        --mb             Same as --build=Module::Build

        --author=name    Author&#39;s name &#40;required&#41;
        --email=email    Author&#39;s email &#40;required&#41;
        --license=type   License under which the module will be distributed
                         &#40;default is the same license as perl&#41;

        --verbose        Print progress messages while working
        --force          Delete pre-existing files if needed

        --help           Show this message

    Example:

slides/slide5.html  view on Meta::CPAN

<div id="content">
<div class="top_spacer"></div>

<pre class="formatter_pre">$ module-starter 
Usage:
    module-starter [options]

    Options:

        --module=module  Module name &#40;required, repeatable&#41;

        --author=name    Author&#39;s name &#40;required&#41;
        --email=email    Author&#39;s email &#40;required&#41;

        --verbose        Print progress messages while working
</pre>

</div>
<!-- BEGIN bottom -->
<div id="bottombar">
<table width="100%">
<tr>
<td align="left" valign="middle">

slides/slide5b.html  view on Meta::CPAN

<div id="content">
<div class="top_spacer"></div>

<h1>With Module::Starter</h1>
<pre class="formatter_pre">$ module-starter 
Usage:
    module-starter [options]

    Options:

        --module=module  Module name &#40;required, repeatable&#41;
        --distro=name    Distribution name &#40;optional&#41;
        --dir=dirname    Directory name to create new module in &#40;optional&#41;

        --builder=module Build with &#39;ExtUtils::MakeMaker&#39; or &#39;Module::Build&#39;
        --eumm           Same as --build=ExtUtils::MakeMaker
        --mb             Same as --build=Module::Build

        --author=name    Author&#39;s name &#40;required&#41;
        --email=email    Author&#39;s email &#40;required&#41;
        --license=type   License under which the module will be distributed
                         &#40;default is the same license as perl&#41;

        --verbose        Print progress messages while working
        --force          Delete pre-existing files if needed

        --help           Show this message

    Example:

slides/slide6.html  view on Meta::CPAN

<div id="content">
<div class="top_spacer"></div>

<pre class="formatter_pre">$ module-starter 
Usage:
    module-starter [options]

    Options:

        --module=module  Module name &#40;required, repeatable&#41;

        --author=name    Author&#39;s name &#40;required&#41;
        --email=email    Author&#39;s email &#40;required&#41;

        --verbose        Print progress messages while working
</pre>

</div>
<!-- BEGIN bottom -->
<div id="bottombar">
<table width="100%">
<tr>
<td align="left" valign="middle">

t/pod-coverage.t  view on Meta::CPAN

#!perl -T

use Test::More;
eval "use Test::Pod::Coverage 1.04";
plan skip_all => "Test::Pod::Coverage 1.04 required for testing POD coverage" if $@;
all_pod_coverage_ok();

t/pod.t  view on Meta::CPAN

#!perl -T

use Test::More;
eval "use Test::Pod 1.14";
plan skip_all => "Test::Pod 1.14 required for testing POD" if $@;
all_pod_files_ok();