Module::Install::ReadmePodFromPod - A Module::Install extension to automatically convert POD to a README.pod
# In Makefile.PL use Module::Install::ReadmePodFromPod; readme_pod_from 'lib/Some/Module.pm';
A README.pod file will be generated from the POD of the indicated module file.
README.pod
Module::Install::ReadmePodFromPod is a Module::Install extension that generates a README.pod file automatically from an indicated file containing POD, whenever the author runs Makefile.PL.
Makefile.PL
With github Since POD rendering support entered I want to place README.pod automatically.
takes many test codes and documents from Module::Install::ReadmeFromPod.
This plugin adds the following Module::Install command:
readme_pod_from
Does nothing on the user-side. On the author-side it will generate a README.pod file using perldoc from the POD in the file passed as a parameter.
readme_pod_from 'lib/Some/Module.pm';
Kazuhiro Osawa <yappo <at> shibuya <döt> pl>
Module::Install, Module::Install::ReadmeFromPod, Pod::Perldoc::ToPod
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
1 POD Error
The following errors were encountered while parsing the POD:
Non-ASCII character seen before =encoding in '<döt>'. Assuming UTF-8
To install Module::Install::ReadmePodFromPod, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Module::Install::ReadmePodFromPod
CPAN shell
perl -MCPAN -e shell install Module::Install::ReadmePodFromPod
For more information on module installation, please visit the detailed CPAN module installation guide.