An open API service indexing awesome lists of open source software.

https://github.com/ydah/railroad_diagrams

🛤️ A tiny Ruby+SVG library for drawing railroad syntax diagrams like JSON.org.
https://github.com/ydah/railroad_diagrams

railroad-diagrams svg syntax-diagrams

Last synced: 28 days ago
JSON representation

🛤️ A tiny Ruby+SVG library for drawing railroad syntax diagrams like JSON.org.

Awesome Lists containing this project

README

        

# RailroadDiagrams [![Gem Version](https://badge.fury.io/rb/railroad_diagrams.svg?icon=si%3Arubygems)](https://badge.fury.io/rb/railroad_diagrams)

A tiny Ruby+SVG library for drawing railroad syntax diagrams.

image

Inspired by: https://github.com/tabatkins/railroad-diagrams

# Installation

Add this line to your application's Gemfile:
```ruby
gem 'railroad_diagrams'
```

Add then execute:
```bash
bundle install
```

Or install it yourself as:
```bash
gem install railroad_diagrams
```

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 `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/ydah/railroad_diagrams.