post_tonal 0.1.0.pre → 0.1.1.pre

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 #CHANGELOG
 
+####October 21, 2012 [0.1.1.pre]
+-Add homepage information to gem specification
+
 ####October 21, 2012 [0.1.0.pre]
 -Implement transposition in PitchClassSet
 -Change normal_form, inversion, and transpose so that they each return a PitchClassSet

data/README.md

@@ -3,6 +3,38 @@ PostTonal
 
 PostTonal is a Ruby library for analyzing sets of musical pitches. It's based on [pitch class set theory](http://en.wikipedia.org/wiki/Set_theory_\(music\) "Pitch class set theory") pioneered by Allen Forte.
 
-Work In Progress: Detailed usage documentation to come soon.
+#Setup
 
+-```gem install post_tonal --pre```, OR  
+-In your Gemfile: ```gem "post_tonal", "~> 0.1.0.pre"```
 
+#Usage
+
+```
+require 'post_tonal'
+
+set = PostTonal::PitchClassSet.new
+
+#Add the set [C, C#, D#, E, G] <-(recognize this collection?)  
+set.add_pitch(0) # or set.add_pitch('c')  
+set.add_pitch(1) # or set.add_pitch('c#')  
+set.add_pitch(3) # or set.add_pitch('d#')  
+set.add_pitch(4) # or set.add_pitch('e')  
+set.add_pitch(6) # or set.add_pitch('g')  
+
+#Get the normal form
+puts set.normal_form
+
+#Get an inversion of the set
+puts set.inversion
+
+#Get a transposition of the set
+puts set.transpose(4)
+
+```
+
+All transformations return a ```new``` PitchClassSet object, and are thus non-destructive. Transformations can be chained.  
+```
+set.inversion.transpose(6)  
+set.normal_form.inversion
+```

data/lib/post_tonal/version.rb

@@ -1,3 +1,3 @@
 module PostTonal
-	VERSION = '0.1.0.pre'
+	VERSION = '0.1.1.pre'
 end

data/post_tonal.gemspec

@@ -8,6 +8,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.author     = 'Eric Rubio'
   s.email       = 'penmanglewood@fastmail.fm'
+  s.homepage    = 'https://github.com/penmanglewood/post_tonal'
   s.summary     = %q{Pitch-class set analysis library}
   s.description = %q{Ruby library for analyzing pitch-class sets according to post-tonal theory}
   s.files         = `git ls-files`.split("\n")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: post_tonal
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre
+  version: 0.1.1.pre
   prerelease: 6
 platform: ruby
 authors:
@@ -82,7 +82,7 @@ files:
 - test/unit/pitch_class_interval_test.rb
 - test/unit/pitch_class_set_test.rb
 - test/unit/pitch_class_test.rb
-homepage: 
+homepage: https://github.com/penmanglewood/post_tonal
 licenses: []
 post_install_message: 
 rdoc_options: []