Acme-CPANModules

 view release on metacpan or  search on metacpan

Changes  view on Meta::CPAN

0.1.5   2019-12-24  Released-By: PERLANCAR; Urgency: low

        - No spec changes.

	- Denote the specification version as just 0.1 instead of 0.1.0.

	- Update the status of cpanratings.perl.org.

	- Revise the 'Using Acme::CPANModules Modules' section (downplay the
	  vaporware website).


0.1.4   2019-11-26  Released-By: PERLANCAR; Urgency: low

	- No spec changes.

	- Mention attribute x.app.cpanmodules.show_entries in example.

README  view on Meta::CPAN

     our $LIST = {
         ...
     };

    The names of the keys in the hash must follow DefHash convention. The
    basic structure is this:

     # an example module list
     {
         summary => 'List of my favorite modules',  # for recommendation of summary, see Recommendations section
         description => <<'_',
     (Some longer description, in Markdown format)

     This is just a list of my favorite modules.
     _

         ## define features to be used by entries. this can be used to generate a
         ## feature comparison matrix among the entries.
         # entry_features => { # optional
         #     feature1 => {summary=>'Summary of feature1', schema=>'str*'}, # default schema is 'bool' if not specified

README  view on Meta::CPAN

    Crooks, Inc.

    _ }, { module => 'Madame::Zita', summary => 'Ask Madame Zita the fortune
    teller', }, ], };

    For more examples, see existing "Acme::CPANModules::*" modules on CPAN.

    If you are using Dist::Zilla to release your distribution, this
    Pod::Weaver plugin might be useful for you:
    Pod::Weaver::Plugin::Acme::CPANModules. It will create an "=head2
    Included modules" section which is POD rendering of your module list so
    users reading your module's documentation can immediately read your
    list.

RECOMMENDATIONS
  module name
    An Acme::CPANModules module is named under "Acme::CPANModules::"
    namespace.

    A personal list should go under your CPAN ID's subnamespace, e.g.
    "Acme::CPANModules::YOURCPANID::Favorite" or

lib/Acme/CPANModules.pm  view on Meta::CPAN

 our $LIST = {
     ...
 };

The names of the keys in the hash must follow L<DefHash> convention. The basic
structure is this:

 # an example module list
 {
     summary => 'List of my favorite modules',  # for recommendation of summary, see Recommendations section
     description => <<'_',
 (Some longer description, in Markdown format)

 This is just a list of my favorite modules.
 _

     ## define features to be used by entries. this can be used to generate a
     ## feature comparison matrix among the entries.
     # entry_features => { # optional
     #     feature1 => {summary=>'Summary of feature1', schema=>'str*'}, # default schema is 'bool' if not specified

lib/Acme/CPANModules.pm  view on Meta::CPAN

             summary => 'Ask Madame Zita the fortune teller',
         },
     ],
 };

For more examples, see existing C<Acme::CPANModules::*> modules on CPAN.

If you are using L<Dist::Zilla> to release your distribution, this
L<Pod::Weaver> plugin might be useful for you:
L<Pod::Weaver::Plugin::Acme::CPANModules>. It will create an C<=head2 Included
modules> section which is POD rendering of your module list so users reading
your module's documentation can immediately read your list.

=head1 RECOMMENDATIONS

=head2 module name

An Acme::CPANModules module is named under C<Acme::CPANModules::> namespace.

A personal list should go under your CPAN ID's subnamespace, e.g.
C<Acme::CPANModules::YOURCPANID::Favorite> or