Beefy Boxes and Bandwidth Generously Provided by pair Networks
Perl Monk, Perl Meditation
 
PerlMonks  

comment on

( [id://3333]=superdoc: print w/replies, xml ) Need Help??
Dont feel irritated LanX, take it easy :)

Yesterday I asked in the chatterbox:

> can I use my Makefile.pl to autogenerate the Readme based on POD of the main module?

and you answered with a nice trick about doing it in a pseudo test file. Nothing bad on both part. I'm investigating the matter.

Your solution is good in the sense it updates the Readme anytime you run prove -l -v so the github/gitlab Readme is always up to date. It is not clean in the sense that tests are for testing.

Using the Makefile.pl on the other hand, will update the Readme only during the make phase so github/gitlab Readme will be always out of date and another git push is needed after make postamble is run.

PS I always look at What are the files in a CPAN distribution? and it says:

> MetaCPAN will display the following documentation files on a release's front page if they exist: ./README / ./README.md / ./README.pod

L*

There are no rules, there are no thumbs..
Reinvent the wheel, then learn The Wheel; may be one day you reinvent one of THE WHEELS.

In reply to Re^2: let Makefile.PL to do the Readme file for me -- new target? by Discipulus
in thread let Makefile.PL to do the Readme file for me -- new target? by Discipulus

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



  • Are you posting in the right place? Check out Where do I post X? to know for sure.
  • Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:
    <code> <a> <b> <big> <blockquote> <br /> <dd> <dl> <dt> <em> <font> <h1> <h2> <h3> <h4> <h5> <h6> <hr /> <i> <li> <nbsp> <ol> <p> <small> <strike> <strong> <sub> <sup> <table> <td> <th> <tr> <tt> <u> <ul>
  • Snippets of code should be wrapped in <code> tags not <pre> tags. In fact, <pre> tags should generally be avoided. If they must be used, extreme care should be taken to ensure that their contents do not have long lines (<70 chars), in order to prevent horizontal scrolling (and possible janitor intervention).
  • Want more info? How to link or How to display code and escape characters are good places to start.
Log In?
Username:
Password:

What's my password?
Create A New User
Domain Nodelet?
Chatterbox?
and the web crawler heard nothing...

How do I use this?Last hourOther CB clients
Other Users?
Others surveying the Monastery: (7)
As of 2024-03-29 09:34 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found