Skip to content

Commit

Permalink
Adds new documentation to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
rewinfrey committed Jul 18, 2012
1 parent 590ad03 commit 5bf5221
Showing 1 changed file with 29 additions and 1 deletion.
30 changes: 29 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,35 @@ If you want to use Nyan Cat as your default formatter, simply put the options in
Playing the Nyan Cat song
-------------------------

If you want to play the Nyan Cat song in tandom with nyan-cat-formatter, simply copy the ".nyan-cat.mp3" file to your home directory.
If you want to play the Nyan Cat song in tandom with nyan-cat-formatter, there are two options:

1. Play the song by default:

Remove the following option from your .rspec file:

```
--format NyanCatFormatter
```

And add the following option to your .rspec file:

```
--format Play
```

2. Play the song only when desired using a command line option:

Make sure the following option is in your .rspec file:

```
--format NyanCatFormatter
```

And use the following command when running specs:

```
$ rspec spec -f Play
```

This currently only works on Mac OSx.

Expand Down

0 comments on commit 5bf5221

Please sign in to comment.