Skip to content

Commit

Permalink
Minor updates to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
beneggett committed Mar 10, 2015
1 parent e6db1e9 commit bd0cdae
Show file tree
Hide file tree
Showing 2 changed files with 60 additions and 3 deletions.
61 changes: 59 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# MusicTheory

TODO: Write a gem description
Learn Music through Ruby!

Based on my presentation at MtnWest Ruby Conference. Slides/link to come.

## Installation

Expand All @@ -20,7 +22,56 @@ Or install it yourself as:

## Usage

TODO: Write usage instructions here
Play any of the sample songs by running them with ruby

```
ruby samples/arpeggios.rb
```


``` ruby
require 'music_theory'
```
Make new notes

```
MusicTheory::Note.new
```

Play Notes

```
MusicTheory::Note.new.play
```

Create scales

```
MusicTheory::Scale.new
```

Play Scales

```
MusicTheory::Scale.new.play
```

Play chords
```
MusicTheory::Scale.new.chord.play
```

Play third
```
MusicTheory::Scale.new.third.play
```

Play arpeggios
```
MusicTheory::Scale.new.arpeggio.play
```



## Contributing

Expand All @@ -29,3 +80,9 @@ TODO: Write usage instructions here
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


## Thanks

1. URUG community
2. Alex Speller (for indirect inspiration)
2 changes: 1 addition & 1 deletion lib/music_theory/version.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
module MusicTheory
VERSION = "0.3.0"
VERSION = "0.3.1"
end

0 comments on commit bd0cdae

Please sign in to comment.