Skip to content

Commit

Permalink
Added some more description to the README
Browse files Browse the repository at this point in the history
  • Loading branch information
cpetersen committed Jul 16, 2024
1 parent ab6993e commit 3d8818e
Showing 1 changed file with 33 additions and 2 deletions.
35 changes: 33 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,9 +77,40 @@ end

## Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.
After checking out the repo, run

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.
```sh
bundle install
```

Then, run

```sh
rake spec
```
to run the tests.

To install this gem onto your local machine, run

```sh
bundle exec rake install
```

To release a new version, update the version number in version.rb, and then run

```sh
bundle exec rake release
```

which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

To use this locally during development, I like to include it whatever project I'm working by adding the following to the `Gemfile` of the other project

```ruby
gem "rrf", path: '/what/ever/path/you/choose/rrf'
```

Then bundle and it will use your development copy.

## Contributing

Expand Down

0 comments on commit 3d8818e

Please sign in to comment.