https://github.com/spilth/chord_diagrams
Generate SVGs for Guitar and Ukulele Chord Diagrams
https://github.com/spilth/chord_diagrams
chords guitar guitar-chords music ruby
Last synced: 5 months ago
JSON representation
Generate SVGs for Guitar and Ukulele Chord Diagrams
- Host: GitHub
- URL: https://github.com/spilth/chord_diagrams
- Owner: spilth
- License: mit
- Created: 2019-05-23T21:23:16.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-10-07T22:15:08.000Z (about 1 year ago)
- Last Synced: 2024-10-07T22:22:47.598Z (about 1 year ago)
- Topics: chords, guitar, guitar-chords, music, ruby
- Language: Ruby
- Homepage: https://rubygems.org/gems/chord_diagrams
- Size: 43.9 KB
- Stars: 6
- Watchers: 2
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# ChordDiagrams [](https://www.travis-ci.com/spilth/chord_diagrams)
Generate SVGs for Guitar and Ukulele Chord Diagrams
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'chord_diagrams'
```
And then execute:
```bash
$ bundle
```
Or install it yourself as:
```bash
$ gem install chord_diagrams
```
## Usage
```ruby
require 'chord_diagrams'
puts ChordDiagrams.guitar_svg('Am')
puts ChordDiagrams.ukulele_svg('Am')
```
## 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.
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/spilth/chord_diagrams.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).