The README file should only have the a synopsis of what the module does and a simple explanation of how to install it if an INSTALL file isn't present. Its the job of the documentation within the module that should explain usage. Having that explanation in the README file is rather redundant in my opinion. CPAN extracts the POD from the module and creates a page that can be viewed on their site for more information. You should be looking there for usage rather than the README file.

It's up to the author of the module or those who take part in its creation to properly document it. Going through some of the modules on CPAN I do see that some of the documentation provided with them is very poor. While others provide an explanation that allows a user to get it right the first time without mucking around.

BMaximus

---

---

Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!

Titles consisting of a single word are discouraged, and in most cases are disallowed outright.

Read Where should I post X? if you're not absolutely sure you're posting in the right place.

Please read these before you post! —

• How do I compose an effective node title?
• How do I post a question effectively?
• Markup in the Monastery

Posts may use any of the Perl Monks Approved HTML tags:

a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, details, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, summary, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr

You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)

	For:		Use:
	&		&
	<		&lt;
	>		&gt;
	[		&#91;
	]		&#93;

Link using PerlMonks shortcuts! What shortcuts can I use for linking?

See Writeup Formatting Tips and other pages linked from there for more info.