Skip to content

Commit dff5b3e

Browse files
committed
Updating the README.md for grammar and clarifications.
This is mainly to force a rebuilding of the site which would actually close #2518 in due time.
1 parent de2a6d5 commit dff5b3e

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,12 @@ This module is available via the Perl 6 module ecosystem. Use:
2525

2626
$ zef install p6doc
2727

28-
to install the binaries and make it available in your binaries
28+
to install the "binaries" and make them available in your binaries
2929
execution path.
3030

31-
**Note**: Please note that, due to changes in the parsing of Pod6, this will fail in versions older than 2018.06. Please upgrade to that version, or install using `--force`.
31+
**Note**: Please note that, due to changes in the parsing of Pod6,
32+
this will fail in versions of Perl 6 older than 2018.06. Please upgrade to that
33+
version, or install using `--force`.
3234

3335
## Use p6doc
3436

@@ -46,14 +48,18 @@ skip the `./bin` part if you have installed it via
4648

4749
$ p6doc -f slurp
4850

49-
to browse the documentation of standard functions. Depending on your
51+
to browse the documentation of standard functions (which, in this
52+
particular case, will actually return multiple matches, which you can
53+
check individually). Depending on your
5054
disk speed and Rakudo version, it might take a while.
5155

5256
-------
5357

5458
## Building the HTML documentation
5559

56-
Install dependencies by running the following in the checkout directory:
60+
You might want to have a copy of the documentation and run the web
61+
site locally yourself. In that case, install dependencies by running
62+
the following in the checkout directory:
5763

5864
$ zef --deps-only install .
5965

0 commit comments

Comments
 (0)