aboutsummaryrefslogtreecommitdiff
path: root/.config/rdm/templates/readme.rakudoc
diff options
context:
space:
mode:
Diffstat (limited to '.config/rdm/templates/readme.rakudoc')
-rw-r--r--.config/rdm/templates/readme.rakudoc41
1 files changed, 41 insertions, 0 deletions
diff --git a/.config/rdm/templates/readme.rakudoc b/.config/rdm/templates/readme.rakudoc
new file mode 100644
index 0000000..5234c71
--- /dev/null
+++ b/.config/rdm/templates/readme.rakudoc
@@ -0,0 +1,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