NAME

readme.pl - Generate README/README.md from POD.

SYNOPSIS

readme.pl -i <input filename> -o <output filename> [args...]

ARGUMENTS

-i, --input

(Required) The input filename. Must be something containing POD.

-o, --output

(Required) The output filename.

-f, --format

(Optional, default md) The format to generate. Values are md and text.

--appveyor <slug>

Add an appveyor badge. <slug> should be of the form username/repo, and should point to the build page.

--avbadge <slug>

Specify the badge image URL, if different from the --appveyor location. <slug> should be of the form username/repo.

--skipfrom <line1> --skipto <line2>

Must be used together or not at all. If specified, lines starting at <line1> and extending to just before <line2> will be omitted from the output. For example, if your POD has an INTERNALS section you want to leave out of the readme, and the next section is AUTHOR, specify

--skipfrom INTERNALS --skipto AUTHOR

LICENSE

The same terms as Perl itself. NO WARRANTY.