Back in 2005, I wrote Pod::Readme. It languished a bit, and David Precious took over maintainership around 2010.
The core idea for this is that README files contain redundant information that is already in the POD, but not everything in the POD should be in the README (such as the details for individual method calls).
It's recommended in Task::Kensho but I'm not aware of many people using it. The few buildtool plugins that generate README files from POD seem to use plain POD-to-text modules.
So I've started re-writing it. My fork is on GitHub. My hope is to have something that module authors will want to use, and will use by default.
Some of the changes I'm working on:
- Using modern Perl (Moose) and requiring Perl 5.10 as a minimum.
- Plugins for inserting the module version, requirements and latest changes: there's a prototype in the git repo, but this will likely change.
- Possible other plugins might be to include the Travis-CI build status.
- Changing the core of it to filter POD rather than parse and translate it (maybe using Pod::Abstract). This will make it easier to generate README files in different formats (POD, Markdown, HTML) instead of just text.
- Configuration that says what sections to include/exclude, as an alternative to saying "=for readme stop" and "=for readme start" in the POD.
- Release separate plugin modules for Module::Install and Dist::Zilla that use it.
I'm open to ideas. So feedback would be appreciated.