medley
Version, currently master branch1 version
- master branchlatestApr 17, 2018
github.com/jwoertink/medley
A crystal shard for doing music related stuff
17 stars
0 dependents
License: MIT
Installation
# Add this to your shard.yml
dependencies:
medley:
github: jwoertink/medley
branch: mastermaster is a branch, not a release, so this tracks it rather than pinning a version.
Then run:
shards installshard.yml
- Crystal
- no constraint declared
- License
- MIT
- Author
- Jeremy Woertink <jeremywoertink@gmail.com>
Dependencies
This version declares no dependencies.
README
# medley
A mixture of music related methods.
## Installation
Install locally
* `git clone git@github.com:jwoertink/medley.git`
* `cd medley/`
* `icr -r ./src/medley.cr`
or add as a dependecy to your project
```yaml
dependencies:
medley:
github: jwoertink/medley
branch: master
```
## Usage
```crystal
require "medley"
# Play with a note
note = Medley::Note.new("G")
puts note.halfstep_up # => "G#"
puts note.wholestep_up # => "A"
puts note.sharp? #=> false
puts note.natural? #=> true
puts note.next_root #=> "A"
puts note.halfstep_down #=> "Gb"
puts note.name #=> "G"
other_note = Medley::Note.new("G#")
other_note.root_matches?(note) #=> true
# Play with a scale
scale = Medley::Scale.new("Cmaj")
scale.notes #=> ["C", "D", "E", "F", "G", "A", "B", "C"]
# Get the flats or sharps from a key of a scale
scale = Medley::Scale.new("Bbmaj")
scale.key.flats #=> ["Bb", "Eb"]
# Learn note patterns from a scale
scale = Medley::Scale.new("Cmaj")
scale.pattern(1, 6, 4, 5) #=> ["C", "A", "F", "G"]
```
## Development
* `crystal spec`
## Contributing
1. Fork it ( https://github.com/jwoertink/medley/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request
## Contributors
- [jwoertink](https://github.com/jwoertink) Jeremy Woertink - creator, maintainer
Documentation
Built from the current release. The first visit to a release nobody has asked for starts its build.
Links
This branch
- Branch
master- Seen
- Apr 17, 2018
- Indexed
- yes
Dependents
No indexed shard depends on this one yet.
Repository
github.com/jwoertink/medley
Metadata
- Created
- Aug 12, 2026
- Updated
- Aug 12, 2026
- Synced
- Aug 12, 2026
- Versions
- 1