README.md
# Lox
[](https://badge.fury.io/rb/lox)
[](https://travis-ci.org/rdodson41/ruby-lox)
[](https://codeclimate.com/github/rdodson41/ruby-lox/maintainability)
[](https://codeclimate.com/github/rdodson41/ruby-lox/test_coverage)
The `lox` gem is an implementation of the
[Lox Language](https://www.craftinginterpreters.com/the-lox-language.html) that
is written in Ruby.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'lox'
```
And then execute:
```bash
bundle install
```
Or install it yourself as:
```bash
gem install lox
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run
`bundle exec rake spec` to run the tests. You can also run `bin/console` for an
interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To
release a new version, update the version number in `lib/lox/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](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at
<https://github.com/rdodson41/ruby-lox>. This project is intended to be a safe,
welcoming space for collaboration, and contributors are expected to adhere to
the
[code of conduct](https://github.com/rdodson41/ruby-lox/blob/master/CODE_OF_CONDUCT.md).
## License
The gem is available as open source under the terms of the
[MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the Lox project's codebases, issue trackers, chat rooms
and mailing lists is expected to follow the
[code of conduct](https://github.com/rdodson41/ruby-lox/blob/master/CODE_OF_CONDUCT.md).