-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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
Change Installation section of README template to numbered list #6942
Conversation
@@ -5,15 +5,15 @@ TODO: Write a description here | |||
## Installation | |||
|
|||
<%- if config.skeleton_type == "lib" -%> | |||
Add this to your application's `shard.yml`: | |||
1. Run `shards init` | |||
2. Add this to your application's `shard.yml`: |
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.
Better to detail what "this" is:
Add the dependency to your application's
shard.yml
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.
Let's exclude "application's". Because a shard.yml
doesn't necessarily has to be used for just one application, it can be used for multiple applications.
So "Add the dependency to your shard.yml
:"
In fact, most of the time you don't have to run |
Most of the time, but not always. I think the section shouldn't be incomplete and describe all steps to install the shard. But I agree, most of the time |
I don't think we should assume that people don't know to use shards, there's obviously not enough space to explain the whole process of installing a shard. |
Looking at one Ruby gem they say:
I think we just need to say:
Nothing else. |
```yaml | ||
dependencies: | ||
<%= config.name %>: | ||
github: <%= config.github_name %>/<%= config.name %> | ||
``` | ||
3. Run `shards install` | ||
2. Run `shards` |
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.
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.
Thak you @r00ster91 👍
@sdogruyol It seems since sometime you stopped squashing commits, which leads to pretty messy commit list, is it intentional? |
@Sija nope it's not intentional. I just hate Github for changing my default merge strategy based on other repositories. I think eventually I need to write a Chrome plugin to avoid that. |
Follow-up of #6914
I didn't put a dot behind step 2 for consistency because there aren't dots either behind the steps in the Contributing section.
So now the Installation section would look like this:
Installation
shard.yml
:shards install