Beefy Boxes and Bandwidth Generously Provided by pair Networks
Think about Loose Coupling
 
PerlMonks  

Re^2: let Makefile.PL to do the Readme file for me -- new target?

by Discipulus (Canon)
on Jan 19, 2021 at 18:04 UTC ( [id://11127109]=note: print w/replies, xml ) Need Help??


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

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.

Replies are listed 'Best First'.
Re^3: let Makefile.PL to do the Readme file for me -- new target?
by LanX (Saint) on Jan 19, 2021 at 18:25 UTC
    I'm easy, just curious.

    > It is not clean in the sense that tests are for testing.

    Well include a check if README is up to date at the end and you got a "clean test". ;-)

    You might also want to ensure that these kind of "tests" are only run when authoring on your machine.

    Cheers Rolf
    (addicted to the Perl Programming Language :)
    Wikisyntax for the Monastery

Re^3: let Makefile.PL to do the Readme file for me -- new target?
by LanX (Saint) on Jan 19, 2021 at 18:30 UTC
    > > MetaCPAN will display the following documentation files on a release's front page if they exist: ./README / ./README.md / ./README.pod

    OK didn't know that ...

    I created README.pod primarly for GitHub.

    Cheers Rolf
    (addicted to the Perl Programming Language :)
    Wikisyntax for the Monastery

Log In?
Username:
Password:

What's my password?
Create A New User
Domain Nodelet?
Node Status?
node history
Node Type: note [id://11127109]
help
Chatterbox?
and the web crawler heard nothing...

How do I use this?Last hourOther CB clients
Other Users?
Others taking refuge in the Monastery: (3)
As of 2024-03-29 05:00 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found