# The following was supposedly scribed by
# Robert Rothenberg
# on Saturday 30 April 2005 10:07 am:
>Some sections like REQUIREMENTS and INSTALLATION could be generated
>automatically. For requirements, parsing the META.yml should be good
>enough. For installation, check if there is a Makefile.PL and/or
> Build.PL.
Maybe only if I have a section like this
...
=for readme REQUIREMENTS->dwim
=for readme INSTALLATION->dwim
...
I.E., I don't want it to dwim unless I tell it to. And, it had better
generate the correct installation instructions (automatically
detecting whether I'm using ExtUtils::MakeMaker or Module::Build, or if
this in an Inline module.)
But what if I have just a small something to add to the beginning of the
boilerplate installation instructions? I.E. "You need to have the
'libraryname' C library installed on your system..."
>Eric: I don't understand the '=for hacking foo' stuff.
>
>In my modules I sometimes add '=begin internal/=end internal' sections
>to document internal methods, but I leave those for anyone hacking a
>module to find: I don't export them to anything.
I was saying that you should build this with the ability to use formats
besides the '=for readme', so that if I'm trying to generate a
"HACKING" file, your parser finds the '=for hacking' sections and
behaves appropriately. Just 's/readme/hacking/' your module (well,
don't *actually* do that; give me an option.)
What if I want to create an INSTALLATION file? How about COPYING?
--Eric
--
Peer's Law: The solution to the problem changes the problem.
---------------------------------------------
http://scratchcomputing.com
---------------------------------------------
