Skip to content

Commit

Permalink
added installation and development sections to the README
Browse files Browse the repository at this point in the history
  • Loading branch information
lorensr committed Nov 22, 2010
1 parent eddd53a commit 7ea5a48
Showing 1 changed file with 37 additions and 1 deletion.
38 changes: 37 additions & 1 deletion README.textile
Original file line number Diff line number Diff line change
@@ -1 +1,37 @@
Check my blog entry "Introducing Cramp":http://m.onkey.org/2010/1/7/introducing-cramp for the details.
Check my blog entry "Introducing Cramp":http://m.onkey.org/2010/1/7/introducing-cramp for the details.

h2. Installation

_If using OS X, first follow the "mysqlplus":https://github.com/oldmoe/mysqlplus installation instructions._

Cramp works with either thin or Rainbows!

<pre>
gem install thin
</pre>

or:

<pre>
gem install rainbows
</pre>

And then:

<pre>
gem install cramp
</pre>

h2. Development

First fork this project. Then:

<pre>
gem install bundler (if you don't have it)
git clone [email protected]:[your-username]/cramp.git
cd cramp
bundle install
rake
</pre>

Make sure your changes include tests that cover those changes. Finally, submit a pull request.

0 comments on commit 7ea5a48

Please sign in to comment.