Revises README.md, closes #1994 #1999
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
JJ
requested changes
May 6, 2018
README.md
Outdated
| @@ -29,7 +29,7 @@ execution path. | |||
|
|
|||
| ## Use p6doc | |||
|
|
|||
| With a Rakudo `perl6` executable in the `PATH`, try | |||
| With a Rakudo `perl6` executable in the `PATH`, try | |||
README.md
Outdated
| @@ -60,11 +60,11 @@ following, to update the shims for installed executables: | |||
| $ rakudobrew rehash | |||
|
|
|||
| In addition to the Perl 6 dependencies, you need to have `graphviz` installed, which | |||
| on Debian you can do by running | |||
| on Debian you can do by running: | |||
There was a problem hiding this comment.
Try to eliminate whitespace from the end of lines.
README.md
Outdated
|
|
||
| $ sudo apt-get install graphviz | ||
|
|
||
| To build the documentation web pages, simply run | ||
| To build the documentation web pages, simply run: |
There was a problem hiding this comment.
Same as above. This will make tests not pass.
README.md
Outdated
| * Add missing documentation for classes, roles, methods or operators. | ||
| * Add usage examples to existing documentation. | ||
| * Proofread and correct the documentation. | ||
| * Tell us about missing documentation by opening issues on github. |
There was a problem hiding this comment.
Maybe use a nicer spelling for GitHub and linking the issues from here?
There was a problem hiding this comment.
Change github →GitHub and also wrap "opening issues in GitHub" with a link to the issues https://github.com/perl6/doc/issues
JJ
approved these changes
May 6, 2018
README.md
Outdated
| * Add missing documentation for classes, roles, methods or operators. | ||
| * Add usage examples to existing documentation. | ||
| * Proofread and correct the documentation. | ||
| * Tell us about missing documentation by opening issues on github. |
There was a problem hiding this comment.
Change github →GitHub and also wrap "opening issues in GitHub" with a link to the issues https://github.com/perl6/doc/issues
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The problem
Solution provided