Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 108 lines (87 sloc) 2.79 kB
da49610 @pat Added textiled readme
pat authored
1 h1. Thinking Sphinx
2
3 h2. Usage
4
5 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.
6
0353c1d @pat Clarifying current Merb support
pat authored
7 Keep in mind that while Thinking Sphinx works for ActiveRecord with Merb, it doesn't yet support DataMapper (although that is planned).
8
b5559f2 @pat Mirroring changes to plain-text README into textile version
pat authored
9 h2. Contributing
10
11 Fork on GitHub and after you've committed tested patches, send a pull request.
12
13 To get the spec suite running, you will need to install the not-a-mock gem if you don't already have it:
14
15 git clone git://github.com/freelancing-god/not-a-mock.git
16 cd not-a-mock
17 rake gem
18 gem install pkg/not_a_mock-1.1.0.gem
04cda0b @henrik More docs on running "rake spec".
henrik authored
19
20 Then install the ginger gem. The steps are the same, except that you might need to sudo the gem install:
b5559f2 @pat Mirroring changes to plain-text README into textile version
pat authored
21
04cda0b @henrik More docs on running "rake spec".
henrik authored
22 git clone git://github.com/freelancing-god/ginger.git
23 cd ginger
24 rake gem
25 sudo gem install pkg/ginger-1.1.0.gem
26
27 Then set up your database:
b5559f2 @pat Mirroring changes to plain-text README into textile version
pat authored
28
29 cp spec/fixtures/database.yml.default spec/fixtures/database.yml
30 mysqladmin -u root create thinking_sphinx
31
04cda0b @henrik More docs on running "rake spec".
henrik authored
32 Make sure you don't have another Sphinx daemon (searchd) running. If you do, quit it with "rake ts:stop"
33 in the app root.
34
b5559f2 @pat Mirroring changes to plain-text README into textile version
pat authored
35 You should now have a passing test suite from which to build your patch on.
36
37 rake spec
38
04cda0b @henrik More docs on running "rake spec".
henrik authored
39 If you get the message "Failed to start searchd daemon", run the spec with sudo:
40
41 sudo rake spec
42
43 If you quit the spec suite before it's completed, you may be left with data in the test
44 database, causing the next run to have failures. Let that run complete and then try again.
45
da49610 @pat Added textiled readme
pat authored
46 h2. Contributors
47
48 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:
49
50 * Joost Hietbrink
51 * Jonathon Conway
52 * Gregory Mirzayantz
53 * Tung Nguyen
54 * Sean Cribbs
55 * Benoit Caccinolo
56 * John Barton
57 * Oliver Beddows
58 * Arthur Zapparoli
59 * Dusty Doris
60 * Marcus Crafter
61 * Patrick Lenz
62 * Björn Andreasson
e27c22d @pat Fixing typo, removing morphology setting if blank/nil - thanks to Jae…
pat authored
63 * James Healy
b5559f2 @pat Mirroring changes to plain-text README into textile version
pat authored
64 * Jae-Jun Hwang
8acf5d8 @pat Adding address fix - thanks to Jason Rust
pat authored
65 * Xavier Shay
27d4a46 @pat Adding Gopal Patel to contributors list
pat authored
66 * Jason Rust
d1d6e89 @pat Adding ERB translation (just like Rails) for database.yml - thanks to…
pat authored
67 * Gopal Patel
f66088f @pat Forgot to add Chris Heald to the contributors list a while ago. Sorry…
pat authored
68 * Chris Heald
18b1f31 @pat Tweaking some useful patches from Josh French slightly
pat authored
69 * Peter Vandenberk
f332781 @pat Adding Andrew Bennett (PotatoSalad) as a contributor
pat authored
70 * Josh French
fb64e49 @pat Adding Jordan to Contributors list
pat authored
71 * Andrew Bennett
0708161 @pat Added Seth Walker to contributors
pat authored
72 * Jordan Fowler
662cd9d @pat Adding Joe Noon to Contributors list
pat authored
73 * Seth Walker
d70aa67 @pat Adding Wolf to contributors list
pat authored
74 * Joe Noon
752804e @pat Adding Rick to contributors list
pat authored
75 * Wolfgang Postler
a12dbd5 @pat Socket fix for database config (thanks to Killian Murphy)
pat authored
76 * Rick Olson
ecad6de @pat Merge branch 'new_paginate'
pat authored
77 * Killian Murphy
78 * Morten Primdahl
e5115d1 @pat Adding Ryan to contributors list
pat authored
79 * Ryan Bates
fa429a5 @pat Adding David Eisinger to contributors list
pat authored
80 * David Eisinger
8b3eed5 @pat Adding Shay to contributors list
pat authored
81 * Shay Arnett
5488445 @pat Removing infinite loop from load_models, and extra load_models call
pat authored
82 * Minh Tran
9340598 @pat Adding Jeremy Durham to contributors list
pat authored
83 * Jeremy Durham
8485e55 @pat Adding Piotr to contributors list
pat authored
84 * Piotr Sarnacki
f4c2fb2 @pat Adding Nicolas and Matt to contributors list
pat authored
85 * Matt Johnson
86 * Nicolas Blanco
8fd0b15 @pat Adding Max Lapshin to contributors list
pat authored
87 * Max Lapshin
55f49a3 @pat Belatedly adding Josh Natanson as a contributor - he suggested the sq…
pat authored
88 * Josh Natanson
5c06663 @pat Tweaking Philip Hallstrom's rake shortcut (and adding him to contribu…
pat authored
89 * Philip Hallstrom
85eedf7 @pat Adding Christian Rishøj to contributors list
pat authored
90 * Christian Rishøj
6ac6950 @pat Tweaking formatting and adding Mike Flester to contributors list
pat authored
91 * Mike Flester
cab2701 @pat Adding Jim Remsik to contributors list
pat authored
92 * Jim Remsik
d422a42 @pat Adding Kennon Ballou to contributors list
pat authored
93 * Kennon Ballou
5f6f3b0 @pat Adding Henrik to contributors list
pat authored
94 * Henrik Nyh
299f524 @pat Adding error handling for when Sphinx is down, and when records no lo…
pat authored
95 * Emil Tin
c0f7bf5 @pat Tweaking Doug Cole's postgres fixes - applying concat fix to attribut…
pat authored
96 * Doug Cole
94c1ee1 @pat Removing merging for the moment - doesn't seem to be reliable
pat authored
97 * Ed Hickey
98 * Evan Weaver
573aa55 @pat Adding ability to have decimal attributes which are treated as floats…
pat authored
99 * Thibaut Barrere
7b8e277 @pat Fixing pid mention in ts:stop, and adding Kristopher Chambers as a co…
pat authored
100 * Kristopher Chambers
3387403 @pat Adding Dmitrij Smalko as a contributor - instance.changed? check was …
pat authored
101 * Dmitrij Smalko
aa145bb @pat Slight restructure of Aleksey Yeschenko's patch for better multi-mode…
pat authored
102 * Aleksey Yeschenko
e929fdf @pat Adding Lachie as a (meta?) contributor for his contribute.rb script
pat authored
103 * Lachie Cox
9f5660c @pat Adding Lourens Naude as a contributor
pat authored
104 * Lourens Naude
c3cd9a3 @pat Adding Tom Davies as a contributor as he provided one of the facets s…
pat authored
105 * Tom Davies
529d43e @pat Refined the facet code, with thanks to Dan Pickett's fork, and added …
pat authored
106 * Dan Pickett
f93c1a5 @pat Adding Alex Caudill to contributors list, slightly tweaking his patch
pat authored
107 * Alex Caudill
Something went wrong with that request. Please try again.