h1. Thinking Sphinx

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.

Keep in mind that while Thinking Sphinx works for ActiveRecord with Merb, it doesn't yet support DataMapper (although that is planned).

h2. Contributing

Fork on GitHub and after you've committed tested patches, send a pull request.

To quickly see if your system is ready to run the thinking sphinx specs, run the contribute.rb script found in the project root directory. Use the following instructions to install any missing requirements.

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 install the ginger gem. The steps are the same, except that you might need to sudo the gem install:

  git clone git://github.com/freelancing-god/ginger.git
  cd ginger
  rake gem
  sudo gem install pkg/ginger-1.1.0.gem
  
Alternatively, install the ginger gem directly from the freelancing-god github repository

  sudo gem sources -a http://gems.github.com
  sudo gem install freelancing-god-ginger

Then set up your database:

  cp spec/fixtures/database.yml.default spec/fixtures/database.yml
  mysqladmin -u root create thinking_sphinx
  
This last step can be done automatically by the contribute.rb script if all dependencies are met.

Make sure you don't have another Sphinx daemon (searchd) running. If you do, quit it with "rake ts:stop"
in the app root.

You should now have a passing test suite from which to build your patch on.

  rake spec

If you get the message "Failed to start searchd daemon", run the spec with sudo:

  sudo rake spec

If you quit the spec suite before it's completed, you may be left with data in the test
database, causing the next run to have failures. Let that run complete and then try again.

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:

* Joost Hietbrink
* Jonathan Conway
* Gregory Mirzayantz
* Tung Nguyen
* Sean Cribbs
* Benoit Caccinolo
* John Barton
* Oliver Beddows
* Arthur Zapparoli
* Dusty Doris
* Marcus Crafter
* Patrick Lenz
* Björn Andreasson
* James Healy
* Jae-Jun Hwang
* Xavier Shay
* Jason Rust
* Gopal Patel
* Chris Heald
* Peter Vandenberk
* Josh French
* Andrew Bennett
* Jordan Fowler
* Seth Walker
* Joe Noon
* Wolfgang Postler
* Rick Olson
* Killian Murphy
* Morten Primdahl
* Ryan Bates
* David Eisinger
* Shay Arnett
* Minh Tran
* Jeremy Durham
* Piotr Sarnacki
* Matt Johnson
* Nicolas Blanco
* Max Lapshin
* Josh Natanson
* Philip Hallstrom
* Christian Rishøj
* Mike Flester
* Jim Remsik
* Kennon Ballou
* Henrik Nyh
* Emil Tin
* Doug Cole
* Ed Hickey
* Evan Weaver
* Thibaut Barrere
* Kristopher Chambers
* Dmitrij Smalko
* Aleksey Yeschenko
* Lachie Cox
* Lourens Naude
* Tom Davies
* Dan Pickett
* Alex Caudill
* Jim Benton
* John Aughey
* Keith Pitty
* Jeff Talbot
* Dana Contreras
* Menno van der Sman
* Bill Harding
* Isaac Feliu
* Andrei Bocan
* László Bácsi
* Peter Wagenet
* Max Lapshin
* Martin Emde
* David Wennergren
* Mark Lane
* Eric Lindvall
* Lawrence Pit
* Mike Bailey
* Bill Leeper
* Michael Reinsch
* Anderson Dias
* Jerome Riga
* Tien Dung
* Johannes Kaefer
* Paul Campbell
* Matthew Beale
* Tom Simnett