summaryrefslogtreecommitdiff
path: root/vendor/plugins/thinking-sphinx/README
diff options
context:
space:
mode:
authorhukl <contact@smyck.org>2009-04-28 00:15:53 +0200
committerhukl <contact@smyck.org>2009-05-01 17:14:02 +0200
commit4bd16f053847f2efe347ebda9136ef2233ee0d2c (patch)
treef4c11f89455de991c8d87726d5757b752e7129e2 /vendor/plugins/thinking-sphinx/README
parentd3a9b46ba5c863a0ff377dcffae9a494fe476e02 (diff)
added thinking_sphinx plugin for fulltext search on nodes and heads
Diffstat (limited to 'vendor/plugins/thinking-sphinx/README')
-rw-r--r--vendor/plugins/thinking-sphinx/README127
1 files changed, 127 insertions, 0 deletions
diff --git a/vendor/plugins/thinking-sphinx/README b/vendor/plugins/thinking-sphinx/README
new file mode 100644
index 0000000..e33cc3e
--- /dev/null
+++ b/vendor/plugins/thinking-sphinx/README
@@ -0,0 +1,127 @@
1= Thinking Sphinx
2
3== 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
9== 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 install the faker gem:
30
31 sudo gem install faker
32
33Then set up your database:
34
35 cp spec/fixtures/database.yml.default spec/fixtures/database.yml
36 cp spec/fixtures/database.yml.default features/support/db/database.yml
37 mysqladmin -u root create thinking_sphinx
38
39Make sure you don't have another Sphinx daemon (searchd) running. If you do, quit it with "rake ts:stop"
40in the app root.
41
42You should now have a passing test suite from which to build your patch on.
43
44 rake spec
45 rake features (Note: You will need MySQL and Postgres gems to run the full suite. You may want to tweak your rakefile)
46
47If you get the message "Failed to start searchd daemon", run the spec with sudo:
48
49 sudo rake spec
50 sudo rake features
51
52If you quit the spec suite before it's completed, you may be left with data in the test
53database, causing the next run to have failures. Let that run complete and then try again.
54
55== Contributors
56
57Since 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:
58
59- Joost Hietbrink
60- Jonathan Conway
61- Gregory Mirzayantz
62- Tung Nguyen
63- Sean Cribbs
64- Benoit Caccinolo
65- John Barton
66- Oliver Beddows
67- Arthur Zapparoli
68- Dusty Doris
69- Marcus Crafter
70- Patrick Lenz
71- Björn Andreasson
72- James Healy
73- Jae-Jun Hwang
74- Xavier Shay
75- Jason Rust
76- Gopal Patel
77- Chris Heald
78- Peter Vandenberk
79- Josh French
80- Andrew Bennett
81- Jordan Fowler
82- Seth Walker
83- Joe Noon
84- Wolfgang Postler
85- Rick Olson
86- Killian Murphy
87- Morten Primdahl
88- Ryan Bates
89- David Eisinger
90- Shay Arnett
91- Minh Tran
92- Jeremy Durham
93- Piotr Sarnacki
94- Matt Johnson
95- Nicolas Blanco
96- Max Lapshin
97- Josh Natanson
98- Philip Hallstrom
99- Christian Rishøj
100- Mike Flester
101- Jim Remsik
102- Kennon Ballou
103- Henrik Nyh
104- Emil Tin
105- Doug Cole
106- Ed Hickey
107- Evan Weaver
108- Thibaut Barrere
109- Kristopher Chambers
110- Dmitrij Smalko
111- Aleksey Yeschenko
112- Lachie Cox
113- Lourens Naude
114- Tom Davies
115- Dan Pickett
116- Alex Caudill
117- Jim Benton
118- John Aughey
119- Keith Pitty
120- Jeff Talbot
121- Dana Contreras
122- Menno van der Sman
123- Bill Harding
124- Isaac Feliu
125- Andrei Bocan
126- László Bácsi
127- Peter Wagenet