Add step in Installation section in README template #6914
Merged
Conversation
This file contains 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
| @@ -12,6 +12,8 @@ dependencies: | |||
| <%= config.name %>: | |||
| github: <%= config.github_name %>/<%= config.name %> | |||
| ``` | |||
|
|
|||
| and run `shards install`. | |||
There was a problem hiding this comment.
This should be a whole sentence (for example Then run shards install`).
There was a problem hiding this comment.
I think this is fine because Add this to your application's shard.yml:, the yaml code and this together is one sentence. "Do this and run this" instead of "Do this. Then run this". So the whole installation is "swifty" and simply described in one sentence.
In the end there isn't really a big difference I think.
There was a problem hiding this comment.
It's hard to read that as a whole sentence given it's two paragraphs with a code block element in between.
straight-shoota
approved these changes
Oct 7, 2018
bcardiff
approved these changes
Oct 7, 2018
RX14
approved these changes
Oct 9, 2018
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.
This documents the
shards installstep in the Installation section of the README template.Because actually the Installation section is without this step incomplete. That's not everything you need to do to install the shard so you can use it.
So now the Installation section for a shard would look like this:
Installation
Add this to your application's
shard.yml:Then run
shards install.