summaryrefslogtreecommitdiff
path: root/vendor/plugins/thinking-sphinx/README.textile
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/plugins/thinking-sphinx/README.textile')
-rw-r--r--vendor/plugins/thinking-sphinx/README.textile120
1 files changed, 0 insertions, 120 deletions
diff --git a/vendor/plugins/thinking-sphinx/README.textile b/vendor/plugins/thinking-sphinx/README.textile
deleted file mode 100644
index d19c8de..0000000
--- a/vendor/plugins/thinking-sphinx/README.textile
+++ /dev/null
@@ -1,120 +0,0 @@
1h1. Thinking Sphinx
2
3h2. Usage
4
5First, 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.
6
7Keep in mind that while Thinking Sphinx works for ActiveRecord with Merb, it doesn't yet support DataMapper (although that is planned).
8
9h2. Contributing
10
11Fork on GitHub and after you've committed tested patches, send a pull request.
12
13To 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.
14
15To get the spec suite running, you will need to install the not-a-mock gem if you don't already have it:
16
17 git clone git://github.com/freelancing-god/not-a-mock.git
18 cd not-a-mock
19 rake gem
20 gem install pkg/not_a_mock-1.1.0.gem
21
22Then install the ginger gem. The steps are the same, except that you might need to sudo the gem install:
23
24 git clone git://github.com/freelancing-god/ginger.git
25 cd ginger
26 rake gem
27 sudo gem install pkg/ginger-1.1.0.gem
28
29Then set up your database:
30
31 cp spec/fixtures/database.yml.default spec/fixtures/database.yml
32 mysqladmin -u root create thinking_sphinx
33
34Make sure you don't have another Sphinx daemon (searchd) running. If you do, quit it with "rake ts:stop"
35in the app root.
36
37You should now have a passing test suite from which to build your patch on.
38
39 rake spec
40
41If you get the message "Failed to start searchd daemon", run the spec with sudo:
42
43 sudo rake spec
44
45If you quit the spec suite before it's completed, you may be left with data in the test
46database, causing the next run to have failures. Let that run complete and then try again.
47
48h2. Contributors
49
50Since 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:
51
52* Joost Hietbrink
53* Jonathan Conway
54* Gregory Mirzayantz
55* Tung Nguyen
56* Sean Cribbs
57* Benoit Caccinolo
58* John Barton
59* Oliver Beddows
60* Arthur Zapparoli
61* Dusty Doris
62* Marcus Crafter
63* Patrick Lenz
64* Björn Andreasson
65* James Healy
66* Jae-Jun Hwang
67* Xavier Shay
68* Jason Rust
69* Gopal Patel
70* Chris Heald
71* Peter Vandenberk
72* Josh French
73* Andrew Bennett
74* Jordan Fowler
75* Seth Walker
76* Joe Noon
77* Wolfgang Postler
78* Rick Olson
79* Killian Murphy
80* Morten Primdahl
81* Ryan Bates
82* David Eisinger
83* Shay Arnett
84* Minh Tran
85* Jeremy Durham
86* Piotr Sarnacki
87* Matt Johnson
88* Nicolas Blanco
89* Max Lapshin
90* Josh Natanson
91* Philip Hallstrom
92* Christian Rishøj
93* Mike Flester
94* Jim Remsik
95* Kennon Ballou
96* Henrik Nyh
97* Emil Tin
98* Doug Cole
99* Ed Hickey
100* Evan Weaver
101* Thibaut Barrere
102* Kristopher Chambers
103* Dmitrij Smalko
104* Aleksey Yeschenko
105* Lachie Cox
106* Lourens Naude
107* Tom Davies
108* Dan Pickett
109* Alex Caudill
110* Jim Benton
111* John Aughey
112* Keith Pitty
113* Jeff Talbot
114* Dana Contreras
115* Menno van der Sman
116* Bill Harding
117* Isaac Feliu
118* Andrei Bocan
119* László Bácsi
120* Peter Wagenet