New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Revises README.md, closes #1994 #1999
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please try and do these changes and resubmit. Thanks a lot for your help.
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe there's a :
missing here?
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe use a nicer spelling for GitHub and linking the issues from here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
what? how?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Change github →GitHub and also wrap "opening issues in GitHub" with a link to the issues https://github.com/perl6/doc/issues
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
OK, looks fine now. 💯
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Change github →GitHub and also wrap "opening issues in GitHub" with a link to the issues https://github.com/perl6/doc/issues
The problem
Solution provided