forked from lifo/cramp
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
added installation and development sections to the README
- Loading branch information
Showing
1 changed file
with
37 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |