Usually instructions on how to install a module are given in INSTALL or README.

If you use Dist::Zilla to build your distribution, and include Dist::Zilla::Plugin::InstallGuide's [InstallGuide] directive in your dist.ini, it will create an INSTALL file automagically, the contents of which look as shown below. Note that you can easily make your own version of such a plugin to customize the instructions.

This is the Perl distribution CMS-Drupal.

Installing CMS-Drupal is straightforward.

## Installation with cpanm

If you have cpanm, you only need one line:

    % cpanm CMS::Drupal

If you are installing into a system-wide directory, you may need to pa
+ss the
"-S" flag to cpanm, which uses sudo to install the module:

    % cpanm -S CMS::Drupal

## Installing with the CPAN shell

Alternatively, if your CPAN shell is set up, you should just be able t
+o do:

    % cpan CMS::Drupal

## Manual installation

As a last resort, you can manually install it. Download the tarball, u
+ntar it,
then build it:

    % perl Makefile.PL
    % make && make test

Then install it:

    % make install

If you are installing into a system-wide directory, you may need to ru
+n:

    % sudo make install

## Documentation

CMS-Drupal documentation is available as POD.
You can run perldoc from a shell to read the documentation:

    % perldoc CMS::Drupal

[download]
The way forward always starts with a minimal test.

In reply to Re: "Best practice" instructions for installing modules by 1nickt
in thread "Best practice" instructions for installing modules by mgv

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post, it's "PerlMonks-approved HTML":


  • Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
  • Titles consisting of a single word are discouraged, and in most cases are disallowed outright.
  • Read Where should I post X? if you're not absolutely sure you're posting in the right place.
  • Please read these before you post! —
  • Posts may use any of the Perl Monks Approved HTML tags:
    a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, details, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, summary, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
  • You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
            For:     Use:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.