Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Mirroring changes to plain-text README into textile version

  • Loading branch information...
commit b5559f2d105238c6e8d3a6f5e98338671d4a9916 1 parent 21b15e6
Pat Allan pat authored
Showing with 22 additions and 1 deletion.
  1. +22 −1 README.textile
23 README.textile
View
@@ -4,6 +4,26 @@ h2. Usage
First, if you haven't done so already, check out the main "usage":http://ts.freelancing-gods.com/usage.html page. Once you've done that, the next place to look for information is the specific method docs - ThinkingSphinx::Search and ThinkingSphinx::Index::Builder in particular.
+h2. Contributing
+
+Fork on GitHub and after you've committed tested patches, send a pull request.
+
+To get the spec suite running, you will need to install the not-a-mock gem if you don't already have it:
+
+ git clone git://github.com/freelancing-god/not-a-mock.git
+ cd not-a-mock
+ rake gem
+ gem install pkg/not_a_mock-1.1.0.gem
+
+Then set up your database
+
+ cp spec/fixtures/database.yml.default spec/fixtures/database.yml
+ mysqladmin -u root create thinking_sphinx
+
+You should now have a passing test suite from which to build your patch on.
+
+ rake spec
+
h2. Contributors
Since I first released this library, there's been quite a few people who have submitted patches, to my immense gratitude. Others have suggested syntax changes and general improvements. So my thanks to the following people:
@@ -22,4 +42,5 @@ Since I first released this library, there's been quite a few people who have su
* Patrick Lenz
* Björn Andreasson
* James Healy
-* Jae-Jun Hwang
+* Jae-Jun Hwang
+* Xavier Shay
Please sign in to comment.
Something went wrong with that request. Please try again.