Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

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