Skip to content

Commit

Permalink
Update README.md (#549)
Browse files Browse the repository at this point in the history
* Update README.md

Add Contributing and Releasing section

* Add note for libvterm

* Squash test command

* Update README.md

Co-authored-by: Stan Lo <stan001212@gmail.com>

---------

Co-authored-by: Stan Lo <stan001212@gmail.com>
  • Loading branch information
ima1zumi and st0012 committed Jun 5, 2023
1 parent 4330a52 commit ffe81c8
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,29 @@ end

See also: [test/reline/yamatanooroti/multiline_repl](https://github.com/ruby/reline/blob/master/test/reline/yamatanooroti/multiline_repl)

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/reline.

### Run tests

> **Note**
> Please make sure you have `libvterm` installed for `yamatanooroti` tests (integration tests).
If you use Homebrew, you can install it by running `brew install libvterm`.

```bash
WITH_VTERM=1 bundle install
WITH_VTERM=1 bundle exec rake test test_yamatanooroti
```

## Releasing

```bash
rake release
gh release create vX.Y.Z --generate-notes
```

## License

The gem is available as open source under the terms of the [Ruby License](https://www.ruby-lang.org/en/about/license.txt).
Expand Down

0 comments on commit ffe81c8

Please sign in to comment.