Beefy Boxes and Bandwidth Generously Provided by pair Networks
Your skill will accomplish
what the force of many cannot
 
PerlMonks  

Re^2: Module Change Log

by Bod (Parson)
on Sep 13, 2022 at 15:17 UTC ( [id://11146857]=note: print w/replies, xml ) Need Help??


in reply to Re: Module Change Log
in thread Module Change Log

Addressing this part in isolation, I hope you're joking

I was half joking and half serious.

The more complex or the more functionality a module has, the more the Change Log is needed. I fully realise that it is important. But, in this case, the module is pretty simple and the change is rather minor, albeit to make it work again. So perhaps a better option would have been ignore it until the next release.

One file I have left as Module::Starter created it is the README.
I am not sure there is anything useful I can put in there that isn't already in POD.

Thoughts of README?

Replies are listed 'Best First'.
Re^3: Module Change Log
by hippo (Bishop) on Sep 13, 2022 at 16:24 UTC

    To my mind, README serves 2 purposes. One is a high-level overview of the dist. With this in mind I will usually include in a README: the current version and release date, a brief description of what the dist does, a list of changes since the last release and the licence and copyright details.

    The other purpose is to tell people new to Perl what to do with the tarball they have just unpacked. So that means including the stuff that Module::Starter has put there already about perl Makefile.PL, etc. and then how to find the more extensive documentation (the POD) which will explain how to use it.


    🦛

      I don't remember the details, but the README used to get installed by make install to a nonsensical path, usually overwriting the previously installed README of a different distribution. I'm not aware whether it's been fixed.

      map{substr$_->[0],$_->[1]||0,1}[\*||{},3],[[]],[ref qr-1,-,-1],[{}],[sub{}^*ARGV,3]

Log In?
Username:
Password:

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

How do I use this?Last hourOther CB clients
Other Users?
Others chilling in the Monastery: (5)
As of 2024-04-23 13:24 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found