This is a combined SOPW/Meditation.

I have written and published to the CPAN a Perl program that has both a web and a CLI interface. I'd like to advertise the CLI interface in the web interface. To do this, I'd have to write some generic instructions for installing a module (App::MyProgram) from the CPAN.

I'm thinking of multiple possibilities: sudo cpan App::MyProgram, cpanm --sudo App::MyProgram (maybe with instructions for installing cpanm), possibly some talk about local::lib, possibly special instructions for Windows users. I am aware of tachyon's A Guide to Installing Modules, but it primarily talks about installing a module from a tarball instead of installing a module straight from the CPAN.

Therefore, What is a best practice piece of HTML that would enlighten a Perl-ignorant user on how to install a Perl module from the CPAN?

This problem gave me an idea. I could build a website that would contain detailed instructions for installing a module from the CPAN. Then I could add to my website's footer <a href="https://install-perl-module.com/App::MyProgram">Install App::MyProgram</a> and users would get the instructions, with copy-able commands that have the correct module name. User-agent sniffing could be used to show OS-specific instructions, and the website would show multiple ways to install the module, sorted by easiness/recommendedness.

Would anyone else find a website like this useful?

In reply to "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.