aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPatrick Spek <p.spek@tyil.nl>2020-01-17 06:25:41 +0100
committerPatrick Spek <p.spek@tyil.nl>2020-01-17 06:25:41 +0100
commit3605da70055d094d9dba61d22fd6888e7afbbbae (patch)
treee2e6a831e434ab7eeb7881e9304ddbcda269eff9
parentfe43edeb11065a7c181c4b97bd4d6f055d20b429 (diff)
downloadPod::To::HTML::Section-3605da70055d094d9dba61d22fd6888e7afbbbae.tar.gz
Pod::To::HTML::Section-3605da70055d094d9dba61d22fd6888e7afbbbae.tar.bz2
Extend documentation
-rw-r--r--README.pod670
1 files changed, 65 insertions, 5 deletions
diff --git a/README.pod6 b/README.pod6
index ff7c5a5..cf6b94e 100644
--- a/README.pod6
+++ b/README.pod6
@@ -12,19 +12,79 @@ raku --doc=HTML::Section <document>
=head1 Description
-Convert a Pod6 document to HTMLN<Well, just a section of it, really>.
+Convert a Pod6 document to HTMLN<Well, just a I<section> of it, really>.
=head1 Installation
-Install this module through L<zef|https://github.com/ugexe/zef>:
+=head2 Through C<zef>
+
+L<zef|https://github.com/ugexe/zef> is the standard distribution manager for
+L<Raku|https://raku.org>. If you're using an end-user distribution like
+L<Rakudo Star|https://rakudo.org/files/star>, it will be installed for you by
+default.
+
+C<zef> will install the latest available version from
+L<CPAN|http://www.cpan.org/modules/index.html>.
+
+=begin code :lang<sh>
+zef install Pod::To::HTML::Section
+=end code
+
+=head2 From a downloaded distribution
+
+All official releases are also made available on my L<personal distribution
+server|https://dist.tyil.nl/raku/modules/>. These can be installed from the URL
+directly.
+
+=begin code :lang<sh>
+zef install https://dist.tyil.nl/raku/modules/Pod-To-HTML-Section-0.1.0.tar.gz
+=end code
+
+Alternatively, you can download the distribution first, and then install that
+copy with C<zef>.
=begin code :lang<sh>
-zef install Pod::To::HTML
+wget https://dist.tyil.nl/raku/modules/Pod-To-HTML-Section-0.1.0.tar.gz
+zef install ./Pod-To-HTML-Section-0.1.0.tar.gz
=end code
+=head1 Contributing
+
+=head2 Reporting bugs or other feedback
+
+Any bugs or other feedback can be sent to my email address. I generally try to
+respond to all mail within 24 hours.
+
+=head2 Proposing code patches
+
+Code patches can also be sent in through email. If you need help to send git
+patches through email, you may want to read up on
+L<git-send-email.io|https://git-send-email.io/>.
+
+=head3 Testing
+
+If you're working on a code patch, you will more than likely want to test your
+own changes to see if they're solving your issue. The easiest way to get the
+HTML out on your terminal is to specify your development copy with C<-I> to
+give it priority, and using C<raku --doc> as usual.
+
+=begin input
+raku -Ilib --doc=HTML::Section <document>
+=end input
+
+However, this may be hard to read for most purposes. If you have C<xmllint> and
+C<tidy> available on your system, you can use these tools in conjuction with
+the C<raku --doc> command to format the HTML.
+
+=begin input
+raku -Ilib --doc=HTML::Section <document> \
+ | xmllint --html - 2>/dev/null \
+ | tidy --indent yes 2>/dev/null
+=end input
+
=head1 License
-This module is distributed under the terms of the GNUN<GNU's Not Unix> AGPLN<Aferro General
-Public License>, version 3.0.
+This module is distributed under the terms of the GNUN<GNU's Not Unix>
+AGPLN<Aferro General Public License>, version 3.0.
=end pod