Skip to content

Commit

Permalink
Updating the README.md for grammar and clarifications.
Browse files Browse the repository at this point in the history
This is mainly to force a rebuilding of the site which would actually
close #2518 in due time.
  • Loading branch information
JJ committed Dec 25, 2018
1 parent de2a6d5 commit dff5b3e
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Expand Up @@ -25,10 +25,12 @@ This module is available via the Perl 6 module ecosystem. Use:

$ zef install p6doc

to install the binaries and make it available in your binaries
to install the "binaries" and make them available in your binaries
execution path.

**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`.
**Note**: Please note that, due to changes in the parsing of Pod6,
this will fail in versions of Perl 6 older than 2018.06. Please upgrade to that
version, or install using `--force`.

## Use p6doc

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

$ p6doc -f slurp

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

-------

## Building the HTML documentation

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

$ zef --deps-only install .

Expand Down

0 comments on commit dff5b3e

Please sign in to comment.