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.

Sign up for GitHub

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

Jump to bottom

Merge redundant usage instructions in README #51

Merged
merged 1 commit into from
Oct 9, 2018
Merged

Merge redundant usage instructions in README #51

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 5 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@ Code style used by AlpineLab in all our projects.

## Usage

1. Add `rubocop` gems to your `Gemfile` (or `gems.rb`, or `gems.deps.rb`):
1. Add those gems to your `Gemfile` (or `gems.rb`, or `gems.deps.rb`):

```ruby
group :development, :test do
gem "alpinelab-codestyle", "~> x.y", require: false
gem "rubocop", "~> x.y", require: false
gem "rubocop-md", "~> x.y", require: false
end
Expand All @@ -16,31 +17,16 @@ Code style used by AlpineLab in all our projects.
or install them manually:

```shell
gem install rubocop rubocop-md
gem install alpinelab-codestyle rubocop rubocop-md
```

2. Add `alpinelab-codestyle` gem to your `Gemfile`
(or `gems.rb`, or `gems.deps.rb`):

```ruby
group :development, :test do
gem "alpinelab-codestyle", "~> x.y"
end
```

or install it manually:

```shell
gem install alpinelab-codestyle
```

3. Create or prepend your Rubocop configuration (usually `.rubocop.yml`) with:
2. Create or prepend your Rubocop configuration (usually `.rubocop.yml`) with:

```yaml
inherit_gem:
alpinelab-codestyle:
- config/default.yml
- config/rails.yml
- config/rails.yml # for Rails projects only
```

## Best practices
Expand Down