Skip to content
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

Add how to install rack-test from github to README. #189

Merged
merged 2 commits into from
Jul 12, 2017

Conversation

junaruga
Copy link
Contributor

@junaruga junaruga commented Jun 18, 2017

We are preparing next version release for rack-test.
However users may want to use unreleased version now before that.
In that case, it is useful for users to know the way to install unreleased version.

You can see modified README here.
https://github.com/junaruga/rack-test/blob/feature/readme-install-from-github/README.md


Or via Bundler:

`gem "rack-test", require: "rack/test"`
```
gem 'rack-test', require: 'rack/test'
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I changed "rack/test" to 'rack/test'. This modification is because rubocop is valid for the single quote code, and it looks more popular.

@junaruga
Copy link
Contributor Author

junaruga commented Jun 18, 2017

I tested like this.

$ cat Gemfile
source 'https://rubygems.org'

# gem 'rack-test', require: 'rack/test'
# gem 'rack-test', github: 'rack-test', branch: 'master'
# gem 'rack-test', github: 'rack-test', ref: 'a5aa1e5eac12bc8007a4bc6af101c24bdc4a2b2e'
gem 'rack-test', github: 'rack-test', ref: 'a5aa1e5'

$ bundle install --path vendor/bundle

$ bundle list
Gems included by the bundle:
  * bundler (1.14.6)
  * rack (2.0.3)
  * rack-test (0.6.3 a5aa1e5)

And related document of Bundler is here. http://bundler.io/v1.15/git.html

@@ -72,11 +72,22 @@ end

To install the latest release as a gem:

`gem install rack-test`
```
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This modification is that I wanted to show same color for the section of Install as a gem and Install via Bundler.
<code>..</code>, <pre>...</pre> are displayed as different color on github markdown.

@junaruga junaruga mentioned this pull request Jun 18, 2017
README.md Outdated

```
gem 'rack-test', github: 'rack-test', branch: 'master'
gem 'rack-test', github: 'rack-test', ref: 'a5aa1e5'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we could skip the second line. Most users will probably not go with a specific ref anyway, but rather a named branch.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with that.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok I will remove the line.

To explain users about the way to install unreleased version.
@junaruga junaruga force-pushed the feature/readme-install-from-github branch from 9c643e7 to 5d95a4f Compare July 12, 2017 08:53
@junaruga
Copy link
Contributor Author

Rebased!

Copy link
Contributor

@perlun perlun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good now, thanks!

@perlun
Copy link
Contributor

perlun commented Jul 12, 2017

(rebase again, then feel free to merge)

@junaruga junaruga merged commit 7dffecd into rack:master Jul 12, 2017
@junaruga
Copy link
Contributor Author

Thanks! Merged.

alex-damian-negru pushed a commit to alex-damian-negru/rack-test that referenced this pull request Apr 5, 2021
To explain users about the way to install unreleased version.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants