On Apr 18, 5:07pm, Michael G Schwern wrote:
> I understand why README files are useful to FTPers. Since I already
> endeavor to put that information into the module docs themselves, my
> basic problem is one of redundancy.
Understand.
> Which is why I tried the mod2readme experiment. If you look at the
> README and INSTALL docs for Text::Metaphone those are all
> autogenerated from the module itself. It includes the NAME, SYNOPSIS,
> DESCRIPTION and AUTHOR sections of the docs along with basic
> installation instructions, a pointer to perlmodinstall and a note
> about any extras you might need. In Text::Metaphone's case it sees
> the XS and notes that you'll need a C compiler.
>
> I never took mod2readme beyond a proof of concept.
Interesting; I'll have to take a look at this further. I already do
a lesser version of this for File::LckPwdF and Term::Prompt, namely printing
out the manpage in plain-text format and using it as the README. All of any
special installation instructions for the former (namely the need for
lckpwdf and ulckpwdf functions) are already in the manpage under "CAVEATS",
incidentally - I did it this way partially because of how I was/am
generating the README and partially because people do look at manpages
via other means than the usual ones with already-installed modules (web
interfaces et al).
-Allen
--
Allen Smith http://cesario.rutgers.edu/easmith/
September 11, 2001 A Day That Shall Live In Infamy II
"They that can give up essential liberty to obtain a little temporary
safety deserve neither liberty nor safety." - Benjamin Franklin
