Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
jamestunnell committed Nov 16, 2014
0 parents commit 91a41e3
Show file tree
Hide file tree
Showing 8 changed files with 122 additions and 0 deletions.
14 changes: 14 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
/.bundle/
/.yardoc
/Gemfile.lock
/_yardoc/
/coverage/
/doc/
/pkg/
/spec/reports/
/tmp/
*.bundle
*.so
*.o
*.a
mkmf.log
4 changes: 4 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
source 'https://rubygems.org'

# Specify your gem's dependencies in musicality.gemspec
gemspec
22 changes: 22 additions & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
Copyright (c) 2014 James Tunnell

MIT License

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
47 changes: 47 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Musicality

The library is based around an abstract representation for music notation. From here, functions are built up to make composing elaborate pieces in this notation representation more manageable. Finally, music performance is supported by providing translation to common formats, like MIDI.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'musicality'
```

And then execute:

$ bundle

Or install it yourself as:

$ gem install musicality

## Usage

Raw notation objects can be created like this:
```ruby
require 'musicality'
include Musicality
include Pitches
include Dynamics

single = Note.quarter(Ab4)
rest = Note.quarter
chord = Note.whole([C3,E3,G3])
part = Part.new(MP, notes:[single,rest,chord])
```

Or, a compact string-representation can be used, instead.
```ruby
Part.new(FF, "/4Ab4 /4 1C3,E3,G3".to_notes)
```

## Contributing

1. Fork it ( https://github.com/[my-github-username]/musicality/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
2 changes: 2 additions & 0 deletions Rakefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
require "bundler/gem_tasks"

5 changes: 5 additions & 0 deletions lib/musicality.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
require "musicality/version"

module Musicality
# Your code goes here...
end
3 changes: 3 additions & 0 deletions lib/musicality/version.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module Musicality
VERSION = "0.0.1"
end
25 changes: 25 additions & 0 deletions musicality.gemspec
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# coding: utf-8
lib = File.expand_path('../lib', __FILE__)
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
require 'musicality/version'

Gem::Specification.new do |spec|
spec.name = "musicality"
spec.version = Musicality::VERSION
spec.authors = ["James Tunnell"]
spec.email = ["[email protected]"]
spec.summary = %q{Music notation, composition, and performance}
spec.description = %q{The library is based around an abstract representation for music notation. \
From here, functions are built up to make composing elaborate pieces in this notation representation more manageable. \
Finally, music performance is supported by providing translation to common formats, like MIDI. }
spec.homepage = "https://github.com/jamestunnell/musicality"
spec.license = "MIT"

spec.files = `git ls-files -z`.split("\x0")
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
spec.require_paths = ["lib"]

spec.add_development_dependency "bundler", "~> 1.7"
spec.add_development_dependency "rake", "~> 10.0"
end

0 comments on commit 91a41e3

Please sign in to comment.