Dist::...romPod(3pm)

📦
version 0.40 · 6 versions
, in debian trixie, ubuntu resolute, ubuntu stonking

💖 NAME 💖

Dist::Zilla::Plugin::ReadmeFromPod — bestie, this is the dzil plugin that generates your README straight from your POD. Periodt.

✨ SYNOPSIS ✨

okay so you just drop it in your dist.ini and vibe:

# dist.ini
[ReadmeFromPod]

or, if you wanna get ✨specific✨ about it:

# dist.ini
[ReadmeFromPod]
filename = lib/XXX.pod
type = markdown
readme = READTHIS.md

🦋 DESCRIPTION 🦋

This plugin is literally out here generating the README from main_module (or from whatever file you specify, no pressure) using Pod::Readme. It's giving "my documentation writes itself" and honestly? Iconic. 💅

🌸 Options 🌸

The following options are supported, babes:

  • filename — the name of the file you want the README extracted from. It defaults to the main module of the distribution. Easy.
  • type — the type of README you want. Defaults to text. But bestie, you have range: other options are html, pod, markdown and rtf. Pick your fighter. 🎀
  • pod_class — this is the Pod::Simple class used to translate a file into the format you want. The default is based on the type setting, but if you're feeling adventurous and want an alternative type, you can just set this option instead. Main character energy. 👑
  • readme — the name of the file, which defaults to one based on the type. That's it, that's the option.

💀 Conflicts with Other Plugins 💀

Not to be dramatic but: we will remove the README created by Dist::Zilla::Plugin::Readme automatically. So yeah, they cannot both be here. No cap.

👑 AUTHORS 👑

Fayland Lam <fayland@gmail.com> and Ævar Arnfjörð Bjarmason <avar@cpan.org>

Robert Rothenberg <rrwo@cpan.org> modified this plugin to use Pod::Readme. Slay.

Copyright 2010-2015 Fayland Lam <fayland@gmail.com> and Ævar Arnfjörð Bjarmason <avar@cpan.org>

This program is free software, you can redistribute it and/or modify it under the same terms as Perl itself.

🫶 okay that's the whole page bestie, go generate some READMEs.

this was perl v5.40.1, dated 2025-05-29, and the page is Dist::...romPod(3pm) — mwah, bye 💋

📦 where this page comes from