Skip to content

Commit

Permalink
Merge pull request #29 from traveltime-dev/update-docs-with-local-dev…
Browse files Browse the repository at this point in the history
…elopment-steps

Update docs with RVM instructions
  • Loading branch information
gergelytraveltime authored Jan 29, 2025
2 parents 43c0ce0 + f0df5e2 commit a4ced8f
Showing 1 changed file with 29 additions and 2 deletions.
31 changes: 29 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -620,11 +620,38 @@ puts response.body

## 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.
### Set up Ruby Version Manager

This is optional, but enables you not installing gems to system directories.

1. Install RVM: https://rvm.io/
2. For Ubuntu, check out: https://rvm.io/integration/gnome-terminal
3. Install and set up Ruby with RVM:
```shell
rvm install ruby-3.2.2
rvm alias create default ruby-3.2.2
rvm use ruby-3.2.2
rvm gemset create traveltime-sdk
```

### Install dependencies

Run `bin/setup` to install dependencies.

### Run tests

Run `rake spec` to run the tests.

### Interactive prompt

Run `bin/console` for an interactive prompt that will allow you to experiment.

### Installing TravelTime gem

To install this gem onto your local machine, run `bundle exec rake install`.

### Release

To release a new version, update the version number in `version.rb` and then create a GitHub release. This will trigger
a GitHub Action which will push the `.gem` file to [rubygems.org](https://rubygems.org).

Expand Down

0 comments on commit a4ced8f

Please sign in to comment.