Module:...FromPod(3)

📦
version 0.04 · 2 versions
, in fedora 43

💖 Module:...FromPod(3) — bestie edition 💖

okay so this is a page from the User Contributed Perl Documentation manual, and the module we're hyping up is Module::Install::ReadmeMarkdownFromPod. yes it's a mouthful. yes it's iconic. sit down, grab a strawberry 🍓, and let's get into it.

✨ NAME ✨

Module::Install::ReadmeMarkdownFromPod — literally just here to create README.mkdn from POD. that's the whole job. she's focused. she's thriving. 💅

✨ SYNOPSIS ✨

    # in Makefile.PL
    use inc::Module::Install;
    name 'Some-Module';
    readme_markdown_from 'lib/Some/Module.pm';

look at her go 🦋 three little lines and boom, README magic.

✨ DESCRIPTION ✨

okay so Module::Install::ReadmeMarkdownFromPod is a Module::Install extension, right? and what it does is generate a README.mkdn file automatically from whatever file you point at that contains POD, every single time the author runs Makefile.PL. 🔥

and why do we care?? because GitHub uses that file to display nicely formatted info about a repository. it's giving main character README energy, no cap. 👑

✨ FUNCTIONS ✨

🌸 readme_markdown_from

on the user-side? does absolutely nothing. zero. nada. she's resting. 😴

on the author-side though? she generates a README.mkdn file using Pod::Markdown, pulling from the POD in the file you passed as a parameter. slay.

    readme_markdown_from 'lib/Some/Module.pm';

now — if you set a second parameter to a true value, then that README.mkdn gets removed at make distclean. clean girl aesthetic ✨

    readme_markdown_from 'lib/Some/Module.pm' => 'clean';
heads up bestie: it will die unless a file name is given. no filename, no vibes, no service. 💀

🌸 readme_markdown_from_pod

like readme_markdown_from, but she assumes all_from has already been called before, and she uses the filename stored there to generate the README.mkdn. then she calls readme_markdown_from with that filename. teamwork!! 🫶

and if you give her an optional boolean parameter, that gets passed along to readme_markdown_from too, indicating whether to clean up the generated README.mkdn file at make distclean time. (this is literally the 'clean' thing from before, but make it modular. iykyk.)

🌸 readme_from_pod

like readme_markdown_from_pod, but she affects the plain-text README file generation done in Module::Install::ReadmeFromPod. 👀

ngl this function would be better placed in that module and might move there eventually. it's given here as a convenience because if you want to generate both README and README.mkdn, you can just do it here without repeating the filename given in all_from. efficiency queen. 🎀

🌸 reference_module

a utility function that saves you from repeatedly naming a reference module from which to extract information. so real of her.

    reference_module 'lib/Some/Module.pm';

is equivalent to:

    all_from 'lib/Some/Module.pm';
    readme_from 'lib/Some/Module.pm';
    readme_markdown_from 'lib/Some/Module.pm';
it will die unless a file name is given. 😭
also — important — reference_module will not work with Shipit::Step::FindVersion, because that module is out here looking for a version_from or all_from string in Makefile.PL. she's not gonna find it, bestie. sorry. 💔

✨ BUGS AND LIMITATIONS ✨

no bugs have been reported. clean record. glowing skin. 🌈⭐

please report any bugs or feature requests through the web interface at <http://rt.cpan.org>. she's listening, fr fr.

✨ INSTALLATION ✨

see perlmodinstall for information and options on installing Perl modules. that's your girl for all things install-related. 📦

✨ AVAILABILITY ✨

the latest version of this module is available from the Comprehensive Perl Archive Network (CPAN). visit <http://www.perl.com/CPAN/> to find a CPAN site near you. or see <http://search.cpan.org/dist/Module-Install-ReadmeMarkdownFromPod/>. 💖

the development version lives at <http://github.com/hanekomu/module-install-readmemarkdownfrompod/>. instead of sending patches, please fork this project using the standard git and github infrastructure. fork it bestie, it's yours now. 🍴✨

✨ AUTHORS ✨

Marcel Grünauer, <marcel@cpan.org> 💐

Copyright 2009 by Marcel Grünauer

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

✨ SEE ALSO ✨

  • Pod::Markdown
  • Module::Install
  • Module::Install::ReadmeFromPod

and that's the whole page, bestie!! 🥳 this was Module:...FromPod(3), perl v5.42.0, dated 2025-07-25 — thank u for coming to my ted talk, go write some READMEs, ily, bye 💜🧚

📦 where this page comes from