{"id":19640364,"url":"https://github.com/kentnl/dist-zilla-plugin-readme-brief","last_synced_at":"2026-06-11T03:31:00.959Z","repository":{"id":25377353,"uuid":"28805562","full_name":"kentnl/Dist-Zilla-Plugin-Readme-Brief","owner":"kentnl","description":"Provide a short simple README with just the essentials","archived":false,"fork":false,"pushed_at":"2020-06-05T06:26:28.000Z","size":234,"stargazers_count":0,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-09T18:57:01.957Z","etag":null,"topics":["dist-zilla","perl"],"latest_commit_sha":null,"homepage":null,"language":"Perl","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kentnl.png","metadata":{"files":{"readme":"README.mkdn","changelog":"Changes","contributing":"CONTRIBUTING.pod","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-01-05T09:18:04.000Z","updated_at":"2020-06-05T06:26:30.000Z","dependencies_parsed_at":"2022-07-25T14:32:46.103Z","dependency_job_id":null,"html_url":"https://github.com/kentnl/Dist-Zilla-Plugin-Readme-Brief","commit_stats":null,"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kentnl%2FDist-Zilla-Plugin-Readme-Brief","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kentnl%2FDist-Zilla-Plugin-Readme-Brief/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kentnl%2FDist-Zilla-Plugin-Readme-Brief/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kentnl%2FDist-Zilla-Plugin-Readme-Brief/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kentnl","download_url":"https://codeload.github.com/kentnl/Dist-Zilla-Plugin-Readme-Brief/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240947648,"owners_count":19883030,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dist-zilla","perl"],"created_at":"2024-11-11T14:05:33.657Z","updated_at":"2026-06-11T03:31:00.924Z","avatar_url":"https://github.com/kentnl.png","language":"Perl","funding_links":[],"categories":[],"sub_categories":[],"readme":"# NAME\n\nDist::Zilla::Plugin::Readme::Brief - Provide a short simple README with just the essentials\n\n# VERSION\n\nversion 0.003003\n\n# SYNOPSIS\n\n    [Readme::Brief]\n    ; Override autodetected install method\n    installer = eumm\n    ; Override autodetected main_module or main_module.pod as a source\n    source_file = lib/Path/To/Module.pm\n    ; Override name to use for brief body\n    description_label = WHAT IS THIS\n\n# DESCRIPTION\n\nThis provides a terse but informative README file for your CPAN distribution\nthat contains just the essential details about your dist a casual consumer would want to know.\n\n- The name of the primary module in the distribution\n- The distribution's main modules description\n- Simple installation instructions from an extracted archive\n- Short copyright information\n\n# NOTE\n\nThis is still reasonably fresh code and reasonably experimental, and feature enhancements and bug fixes\nare actively desired.\n\nHowever, bugs are highly likely to be encountered, especially as there are no tests.\n\n# MECHANICS\n\n- Heading is derived from the `package` statement in the `source_file`\n- Description is extracted as the entire `H1Nest` of the section titled `DESCRIPTION` ( or whatever `description_label` is ) in the `source_file`\n- Installation instructions are automatically determined by the presence of either\n    - A `Makefile.PL` file in your dist ( Where it assumes `EUMM` style )\n    - A `Build.PL` file in your dist ( where it assumes `Module::Build` style )\n    - In the case of both, only instructions for `Makefile.PL` will be emitted.\n    - All of the above behavior can be overridden using the [`installer`](#installer) attribute.\n- _ALL_ Copyright and license details are extracted from the `source_file` in any `H1Nest` that has either `COPYRIGHT` or `LICENSE` in the heading.\n- Or failing such a section, a `COPYRIGHT AND LICENSE` section will be derived from `zilla-\u003elicense`\n\n# ATTRIBUTES\n\n## source\\_file\n\nDetermines the file that will be parsed for POD to populate the README from.\n\nBy default, it uses your `main_module`, except if you have a `.pod` file with\nthe same basename and path as your `main_module`, in which case it uses that.\n\nThis parameter and associated `.pod` support is new in `v0.003000`\n\n## installer\n\nDetermines what installers to document in the `INSTALLATION` section.\n\nBy default, that section is determined based on the presence of certain\nfiles in your `dist`.\n\nHowever, in the event you have multiple installers supported, manually specifying\nthis attribute allows you to control which, or all, and the order.\n\n    installer = eumm ; # only eumm\n\n    installer = eumm\n    installer = mb     ; EUMM shown first, MB shown second\n\n    installer = mb\n    installer = eumm   ; EUMM shown second, MB shown first\n\nThe verbiage however has not yet been cleaned up such that having both is completely lucid.\n\nThis parameter was introduced in version `v0.002000`\n\n## description\\_label\n\nThis case-insensitive attribute defines what `=head1` node will be used for the description section of the brief.\n\nBy default, this is `DESCRIPTION`.\n\nThis parameter was introduced in version `v0.003000`\n\n# SEE ALSO\n\nHere are some competing modules and how this module differs from them.\n\n- [`[Readme]`](https://metacpan.org/pod/Dist::Zilla::Plugin::Readme)\n\n    Gives a much briefer more generic `README` file, which lacks quite as much readable content,\n    and contains no installation instructions.\n\n- [`[ReadmeFromPod]`](https://metacpan.org/pod/Dist::Zilla::Plugin::ReadmeFromPod)\n\n    Provides various output formats, but ultimately is a transformer of your `source_file`'s `POD`,\n    which is excessive for some peoples tastes. ( And lacks install instructions )\n\n- [`[ReadmeAnyFromPod]`](https://metacpan.org/pod/Dist::Zilla::Plugin::ReadmeAnyFromPod)\n\n    Based on the above provides a bunch of extra features, but is ultimately limited\n    in similar ways with regards to install details and verbosity.\n\n- [`[Pod2Readme]`](https://metacpan.org/pod/Dist::Zilla::Plugin::Pod2Readme)\n\n    Possibly the most straight forward `POD` → `README` translator, but limited like the above\n    in that it is _only_ a `POD` translator, but lacks the install instructions aspect.\n\n- [`[InstallGuide]`](https://metacpan.org/pod/Dist::Zilla::Plugin::InstallGuide)\n\n    The polar opposite approach that only focuses on elaborate installation instructions in `INSTALL`,\n    but lacks any of the `POD` and `COPYRIGHT` elements.\n\n# AUTHOR\n\nKent Fredric \u003ckentnl@cpan.org\u003e\n\n# COPYRIGHT AND LICENSE\n\nThis software is copyright (c) 2020 by Kent Fredric \u003ckentfredric@gmail.com\u003e.\n\nThis is free software; you can redistribute it and/or modify it under\nthe same terms as the Perl 5 programming language system itself.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkentnl%2Fdist-zilla-plugin-readme-brief","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkentnl%2Fdist-zilla-plugin-readme-brief","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkentnl%2Fdist-zilla-plugin-readme-brief/lists"}