Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 158 lines (131 sloc) 4.057 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
290585d @yob mention contribute.rb in the README
yob authored
13 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.
14
b5559f2 @pat Mirroring changes to plain-text README into textile version
pat authored
15 To 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
04cda0b @henrik More docs on running "rake spec".
henrik authored
21
22 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
23
04cda0b @henrik More docs on running "rake spec".
henrik authored
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
3f31cb2 Update README with newer instructions
Tom Simnett authored
28
29 Alternatively, install the ginger gem directly from the freelancing-god github repository
30
31 sudo gem sources -a http://gems.github.com
32 sudo gem install freelancing-god-ginger
22d1c3f @wardbekker updated docs & contribute script for new/missing dependencies
wardbekker authored
33
34 Then install the cucumber, yard, jeweler and rspec gems. Make sure you have a git install version 1.6.0.0 or higher, otherwise the jeweler gem won't install.
35
36 sudo gem install cucumber yard jeweler rspec
04cda0b @henrik More docs on running "rake spec".
henrik authored
37
38 Then set up your database:
b5559f2 @pat Mirroring changes to plain-text README into textile version
pat authored
39
40 cp spec/fixtures/database.yml.default spec/fixtures/database.yml
41 mysqladmin -u root create thinking_sphinx
3f31cb2 Update README with newer instructions
Tom Simnett authored
42
43 This last step can be done automatically by the contribute.rb script if all dependencies are met.
b5559f2 @pat Mirroring changes to plain-text README into textile version
pat authored
44
04cda0b @henrik More docs on running "rake spec".
henrik authored
45 Make sure you don't have another Sphinx daemon (searchd) running. If you do, quit it with "rake ts:stop"
46 in the app root.
47
b5559f2 @pat Mirroring changes to plain-text README into textile version
pat authored
48 You should now have a passing test suite from which to build your patch on.
49
50 rake spec
51
04cda0b @henrik More docs on running "rake spec".
henrik authored
52 If you get the message "Failed to start searchd daemon", run the spec with sudo:
53
54 sudo rake spec
55
56 If you quit the spec suite before it's completed, you may be left with data in the test
57 database, causing the next run to have failures. Let that run complete and then try again.
58
da49610 @pat Added textiled readme
pat authored
59 h2. Contributors
60
61 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:
62
63 * Joost Hietbrink
951f23e @pat Fixing long-standing typo of Jonathan's name. Oops
pat authored
64 * Jonathan Conway
da49610 @pat Added textiled readme
pat authored
65 * Gregory Mirzayantz
66 * Tung Nguyen
67 * Sean Cribbs
68 * Benoit Caccinolo
69 * John Barton
70 * Oliver Beddows
71 * Arthur Zapparoli
72 * Dusty Doris
73 * Marcus Crafter
74 * Patrick Lenz
75 * Björn Andreasson
e27c22d @pat Fixing typo, removing morphology setting if blank/nil - thanks to Jae-Ju...
pat authored
76 * James Healy
b5559f2 @pat Mirroring changes to plain-text README into textile version
pat authored
77 * Jae-Jun Hwang
8acf5d8 @pat Adding address fix - thanks to Jason Rust
pat authored
78 * Xavier Shay
27d4a46 @pat Adding Gopal Patel to contributors list
pat authored
79 * Jason Rust
d1d6e89 @pat Adding ERB translation (just like Rails) for database.yml - thanks to Pe...
pat authored
80 * Gopal Patel
f66088f @pat Forgot to add Chris Heald to the contributors list a while ago. Sorry Ch...
pat authored
81 * Chris Heald
18b1f31 @pat Tweaking some useful patches from Josh French slightly
pat authored
82 * Peter Vandenberk
f332781 @pat Adding Andrew Bennett (PotatoSalad) as a contributor
pat authored
83 * Josh French
fb64e49 @pat Adding Jordan to Contributors list
pat authored
84 * Andrew Bennett
0708161 @pat Added Seth Walker to contributors
pat authored
85 * Jordan Fowler
662cd9d @pat Adding Joe Noon to Contributors list
pat authored
86 * Seth Walker
d70aa67 @pat Adding Wolf to contributors list
pat authored
87 * Joe Noon
752804e @pat Adding Rick to contributors list
pat authored
88 * Wolfgang Postler
a12dbd5 @pat Socket fix for database config (thanks to Killian Murphy)
pat authored
89 * Rick Olson
ecad6de @pat Merge branch 'new_paginate'
pat authored
90 * Killian Murphy
91 * Morten Primdahl
e5115d1 @pat Adding Ryan to contributors list
pat authored
92 * Ryan Bates
fa429a5 @pat Adding David Eisinger to contributors list
pat authored
93 * David Eisinger
8b3eed5 @pat Adding Shay to contributors list
pat authored
94 * Shay Arnett
5488445 @pat Removing infinite loop from load_models, and extra load_models call
pat authored
95 * Minh Tran
9340598 @pat Adding Jeremy Durham to contributors list
pat authored
96 * Jeremy Durham
8485e55 @pat Adding Piotr to contributors list
pat authored
97 * Piotr Sarnacki
f4c2fb2 @pat Adding Nicolas and Matt to contributors list
pat authored
98 * Matt Johnson
99 * Nicolas Blanco
8fd0b15 @pat Adding Max Lapshin to contributors list
pat authored
100 * Max Lapshin
55f49a3 @pat Belatedly adding Josh Natanson as a contributor - he suggested the sql_p...
pat authored
101 * Josh Natanson
5c06663 @pat Tweaking Philip Hallstrom's rake shortcut (and adding him to contributor...
pat authored
102 * Philip Hallstrom
85eedf7 @pat Adding Christian Rishøj to contributors list
pat authored
103 * Christian Rishøj
6ac6950 @pat Tweaking formatting and adding Mike Flester to contributors list
pat authored
104 * Mike Flester
cab2701 @pat Adding Jim Remsik to contributors list
pat authored
105 * Jim Remsik
d422a42 @pat Adding Kennon Ballou to contributors list
pat authored
106 * Kennon Ballou
5f6f3b0 @pat Adding Henrik to contributors list
pat authored
107 * Henrik Nyh
299f524 @pat Adding error handling for when Sphinx is down, and when records no longe...
pat authored
108 * Emil Tin
c0f7bf5 @pat Tweaking Doug Cole's postgres fixes - applying concat fix to attributes ...
pat authored
109 * Doug Cole
94c1ee1 @pat Removing merging for the moment - doesn't seem to be reliable
pat authored
110 * Ed Hickey
111 * Evan Weaver
573aa55 @pat Adding ability to have decimal attributes which are treated as floats - ...
pat authored
112 * Thibaut Barrere
7b8e277 @pat Fixing pid mention in ts:stop, and adding Kristopher Chambers as a contr...
pat authored
113 * Kristopher Chambers
3387403 @pat Adding Dmitrij Smalko as a contributor - instance.changed? check was his...
pat authored
114 * Dmitrij Smalko
aa145bb @pat Slight restructure of Aleksey Yeschenko's patch for better multi-model r...
pat authored
115 * Aleksey Yeschenko
e929fdf @pat Adding Lachie as a (meta?) contributor for his contribute.rb script
pat authored
116 * Lachie Cox
9f5660c @pat Adding Lourens Naude as a contributor
pat authored
117 * Lourens Naude
c3cd9a3 @pat Adding Tom Davies as a contributor as he provided one of the facets solu...
pat authored
118 * Tom Davies
529d43e @pat Refined the facet code, with thanks to Dan Pickett's fork, and added dri...
pat authored
119 * Dan Pickett
f93c1a5 @pat Adding Alex Caudill to contributors list, slightly tweaking his patch
pat authored
120 * Alex Caudill
7bddb18 @pat Adding Jim Benton to contributors list
pat authored
121 * Jim Benton
eb9a2ef @pat Adding John Aughey to contributors list
pat authored
122 * John Aughey
41deee2 @pat Adding Keith to contributors list
pat authored
123 * Keith Pitty
b9e4294 @pat Adding Jeff Talbot to contributors list
pat authored
124 * Jeff Talbot
b7a6548 @pat Adding Dana Contreras as a contributor
pat authored
125 * Dana Contreras
b33311b @pat Adding Menno van der Sman as a contributor
pat authored
126 * Menno van der Sman
d91011d @pat Another step towards making Thinking Sphinx on Windows a happier experie...
pat authored
127 * Bill Harding
b886614 @pat Adding Isaac Feliu as a contributor
pat authored
128 * Isaac Feliu
ce0c8dd @pat Adding Andrei Bocan as a contributor
pat authored
129 * Andrei Bocan
ceced87 @pat Adding László Bácsi as a contributor, and refactoring JRuby patches slig...
pat authored
130 * László Bácsi
f288e4a @pat Adding Peter Wagenet as a contributor
pat authored
131 * Peter Wagenet
9a41b91 @pat Got minimal delta updates working. Many thanks to Max Lapshin for initia...
pat authored
132 * Max Lapshin
389c61f @pat Updating version and adding Martin Emde to contributors list
pat authored
133 * Martin Emde
eaedab8 @pat Adding condition to delta reset for indexing
pat authored
134 * David Wennergren
897671c @pat Adding forced-load of I18n to ensure translations are loaded before mode...
pat authored
135 * Mark Lane
fd98a04 @pat Adding Eric and Lawrence as contributors, updating version, fixing time-...
pat authored
136 * Eric Lindvall
137 * Lawrence Pit
2e9d886 @pat Capistrano task fix, thanks to Mike Bailey. Can now use require instead ...
pat authored
138 * Mike Bailey
f36357a @pat :sort_mode search option is now respected when strings are passed in via...
pat authored
139 * Bill Leeper
140 * Michael Reinsch
158a202 @pat Adding rebuild rake task, from a patch provided by Anderson Dias.
pat authored
141 * Anderson Dias
6339fdd @pat Adding Jerome Riga as a contributor
pat authored
142 * Jerome Riga
cd9cf7b @pat Adding Tien Dung to the contributors list, for submitting a patch that w...
pat authored
143 * Tien Dung
9957b16 @pat Adding global and index-level setting - disable_range - to make life eas...
pat authored
144 * Johannes Kaefer
cf96460 @pat Adding Paul to contributors list.
pat authored
145 * Paul Campbell
2019baf @pat Adding Matthew Beale and Tom Simnett as contributors
pat authored
146 * Matthew Beale
147 * Tom Simnett
3e358c4 @pat Adding Erik Ostrom as a contributor
pat authored
148 * Erik Ostrom
141d7fa @pat Tweaking of commit by new contributor Ole Riesenberg to ensure features ...
pat authored
149 * Ole Riesenberg
9a41ba8 @pat Adding Josh Kalderimis as a contributor, and bumping up the version.
pat authored
150 * Josh Kalderimis
f6f5e63 @pat Adding J.D. Hollis to contributors list
pat authored
151 * J.D. Hollis
6e42248 @pat Updating version, adding Jeff as a contributor, and the alt-primary-key ...
pat authored
152 * Jeffrey Chupp
7a29dcf @pat Adding Rob Anderton to contributors list
pat authored
153 * Rob Anderton
919ca3d @zachinglis Adding my name to Contributors
zachinglis authored
154 * Zach Inglis
4f6bbc5 @pat Adding Ward Bekker as a contributor
pat authored
155 * Ward Bekker
8050620 @pat Adding Brian Terlson to contributors list.
pat authored
156 * Brian Terlson
cc89df3 @pat With some help from Christian Aust, fixing MVA string facets.
pat authored
157 * Christian Aust
Something went wrong with that request. Please try again.