Skip to content

Commit

Permalink
Link to docs (#151)
Browse files Browse the repository at this point in the history
Converging on having all the setup docs in one place
gdiggs authored Nov 10, 2016

Verified

This commit was signed with the committer’s verified signature.
1 parent b3279e2 commit 59b4668
Showing 1 changed file with 2 additions and 28 deletions.
30 changes: 2 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -11,34 +11,8 @@ Code Climate - [https://codeclimate.com](https://codeclimate.com)

This gem requires a user, but not necessarily a paid account, on Code Climate,
so if you don't have one the first step is to signup at:
[https://codeclimate.com](https://codeclimate.com). Then:

* Add this to your Gemfile:

```ruby
group :test do
gem "simplecov"
gem "codeclimate-test-reporter", "~> 1.0.0"
end
```

* Start [SimpleCov](https://github.com/colszowka/simplecov) right at the top of
your `spec/spec_helper.rb`, `test/test_helper.rb`, or cucumber `env.rb`.

```ruby
require 'simplecov'
SimpleCov.start
```

* Set the `CODECLIMATE_REPO_TOKEN` environment variable (provided after you add
your repo to your Code Climate account by clicking on "Setup Test Coverage" on
the right hand side of your feed)
* Run the `codeclimate-test-reporter` executable after your test suite

```
bundle exec rake
bundle exec codeclimate-test-reporter
```
[https://codeclimate.com](https://codeclimate.com). Then follow the
instructions on our [documentation site](https://docs.codeclimate.com/docs/ruby)

Please contact [email protected] if you need any assistance setting this up.

0 comments on commit 59b4668

Please sign in to comment.