Beefy Boxes and Bandwidth Generously Provided by pair Networks
go ahead... be a heretic

Re^3: Module Change Log

by hippo (Bishop)
on Sep 13, 2022 at 16:24 UTC ( [id://11146865] : note . print w/replies, xml ) Need Help??

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

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.


Replies are listed 'Best First'.
Re^4: Module Change Log
by choroba (Cardinal) on Sep 13, 2022 at 22:06 UTC
    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]