From b5559f2d105238c6e8d3a6f5e98338671d4a9916 Mon Sep 17 00:00:00 2001 From: Pat Allan Date: Sat, 24 May 2008 17:15:10 +1000 Subject: [PATCH] Mirroring changes to plain-text README into textile version --- README.textile | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/README.textile b/README.textile index 799873470..f71e6821d 100644 --- a/README.textile +++ b/README.textile @@ -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 \ No newline at end of file +* Jae-Jun Hwang +* Xavier Shay \ No newline at end of file