user-pic

hank.sola

  • Commented on What should be in a CPAN distro README?
    README files (IMO, and in general - not Perl specific) have been the thing that explains what a directory contains, and what to do to make it useful (e.g. build instructions)....
Subscribe to feed Recent Actions from hank.sola

  • ivan.wills commented on What should be in a CPAN distro README?

    I have been doing some playing with node modules recently, in that space the README files generally are quite useful giving a description of the module and some comments on installing and usage description. This isn't as useful for CPAN modules as we have good documentation in metacpan where as npm.org is somewhat lacking (go POD).

    When I have come to trying to contribute to the node or perl modules though I tend to be looking at github not metacpan or npm.org so their better README is helpful. I have noticed the fondness of dzil users to not have README files is some what depressing…

  • https://www.google.com/accounts/o8/id?id=AItOawmvC7NYQ48lyWVxfV8N5GAiyr-CDvYD2yo commented on What should be in a CPAN distro README?

    I liked this idea a great deal. So much so that I adopted it in the Git::Hooks module.

    However, after releasing it I got a pull request explaining that there are some problems in keeping a README.pod file at the root of my distribution because it will be installed in the wrong place. (In my case, as Git::README instead of Git::Hooks::README.)

    One solution would be to rename it to README.md and replace POD with Markdo…

Subscribe to feed Responses to Comments from hank.sola

About blogs.perl.org

blogs.perl.org is a common blogging platform for the Perl community. Written in Perl with a graphic design donated by Six Apart, Ltd.