aboutsummaryrefslogtreecommitdiff
path: root/.config/rdm/templates/readme.rakudoc
blob: 5234c7162a641685b4b02885704f4111e6850b05 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
=begin pod

=NAME    {{ name }}
=AUTHOR  {{ author }}
=VERSION {{ version }}

=head1 Description

{{ description }}

=head1 Installation

Install this module through L<zef|https://github.com/ugexe/zef>:

=begin code :lang<sh>
zef install {{ name }}
=end code

=head1 Documentation

Documentation is written as L<Pod6|https://docs.raku.org/language/pod>
documents, and can be read with C<raku>'s C<--doc> option.

=begin input
raku --doc {{ name }}
=end input

At your option, you can also use prettier readers, such as
L<C<p6doc>|https://modules.raku.org/search/?q=p6doc> or
L<C<App::Rakuman>|https://modules.raku.org/dist/App::Rakuman:cpan:TYIL>.

=begin input
p6doc {{ name }}
rakuman {{ name }}
=end input

=head1 License

This module is distributed under the terms of the {{ license }}.

=end pod