view release on metacpan or  search on metacpan

README  view on Meta::CPAN

    @Module_Lists contains module lists.

    Each author/module list is just a hash structure (DefHash). The basic
    structure is this:

     # an example author list
     {
         #id => 'GUID', # optional, can be set to ease list identification/referral
         summary => 'My favorite modules',
         description => <<_,
     (Some longer description, in Markdown format)
    
     This is just a list of my favorite modules.
     _
         entries => [
             {...},
             ...
         ],
     }
    
     # an example module list
     {
         #id => 'GUID', # optional, can be set to ease list identification/referral
         summary => 'My favorite authors',
         description => <<'_',
     (Some longer description, in Markdown format)
    
     This is just a list of my favorite authors.
     _
         entries => [
             {...},
             ...
         ],

    Each entry is another, similar hash structure (DefHash):

     # an example author list entry
     {
         author => 'RJBS',
         summary => 'Kick-ass projects',
         description => <<'_',
     He is my favorite author because he starts some kick-ass projects which I
     use daily, one of which is Dist::Zilla. It has saved me so much time, as
     well wasted countless, because by using Dist::Zilla I am motivated to
     release lots and lots of Perl modules.
     _
         # rating => 10, # optional, on a 1-10 scale
         # alternate_authors => ['SOMEONE', 'ANOTHER'], # optional, if you want to express alternate author(s)
     }
    
     # an example module list entry
     {
         module => 'Data::Dump',
         summary => 'Pretty output',
         description => <<'_',
     Data::Dump is my favorite dumping module because it outputs Perl code that
     is pretty and readable.
     _
         # rating => 10, # optional, on a 1-10 scale
         # alternate_modules => [...], # if you are reviewing an undesirable module and want to suggest better alternative(s)
         # related_modules => ['Data::Dump::Color', 'Data::Dumper'], # if you want to specify related modules that are not listed on the other entries of the same list
     }

    That's it. After you have completed your lists, publish your
    Acme::CPANLists module to CPAN.

    If you are using Dist::Zilla to release your distribution, this
    Pod::Weaver plugin might be useful for you:
    Pod::Weaver::Plugin::Acme::CPANLists. It will create an AUTHOR LISTS
    and MODULE LISTS POD sections which are POD rendering of your
    author/module lists so users reading your module's documentation can
    immediately read your lists.

USING ACME::CPANLISTS MODULES

    As said earlier, a website/online service that collects and indexes all
    Acme::CPANLists modules on CPAN is coming in the future.

    In the meantime, you can install the acme-cpanlists CLI script (from
    the App::AcmeCpanlists distribution). It can list installed
    Acme::CPANLists modules and view the entries of a list.

    Putting similar/related modules together in an Acme::CPANLists can also
    help the lcpan script find related modules (lcpan related-mods). See
    the lcpan documentation or lcpan related-mods --help for more details.

SEE ALSO

    Acme::CPANLists::* modules

    acme-cpanlists from App::AcmeCpanlists