in reply to Re^2: What should be in the README for a module?
in thread What should be in the README for a module?

Here are a few of my thoughts:
I look in the pod for a SYNOPSIS or DESCRIPTION paragraph for this.

I would still put this information in the README, because the README will most likely be the first thing looked at.

But what if it's a simple module that needs no explanation beyond perl Makefile.PL ... make install? Presumably, the installation does not need mentioning.

For the simple installations I would still put the basic install information. The way I see you can't put to much information into the README, as long as it is well organized. If the README is disorganized it really doesn't matter what is put in it.

  • Comment on Re^3: What should be in the README for a module?

In Section Seekers of Perl Wisdom