Path: | README |
Last Update: | Wed Apr 22 05:16:15 -0400 2009 |
Ferret is a Ruby port of the Java Lucene search engine. (jakarta.apache.org/lucene/) In the same way as Lucene, it is not a standalone application, but a library you can use to index documents and search for things in them later.
If you have gems installed you can simply do;
gem install ferret
Otherwise, you will need Rake installed. De-compress the archive and enter its top directory.
tar zxpvf ferret-<version>.tar.gz cd ferret-<version>
Run the following;
$ rake ext $ ruby setup.rb config $ ruby setup.rb setup # ruby setup.rb install
These simple steps install ferret in the default location of Ruby libraries. You can also install files into your favorite directory by supplying setup.rb some options. Try;
$ ruby setup.rb --help
You can read the TUTORIAL which you‘ll find in the same directory as this README. You can also check the following modules for more specific documentation.
We are unaware of any alternatives that can out-perform Ferret while still matching it in features.
For bug reports and patches I have set up Trac here;
http://ferret.davebalmain.com/trac
Queries, discussion etc should be addressed to the mailing lists here;
http://rubyforge.org/projects/ferret/
Alternatively you could create a new page for discussion on the Ferret wiki;
http://ferret.davebalmain.com/trac
Of course, since Ferret was ported from Apache Lucene, most of what you can do with Lucene you can also do with Ferret.
Ferret is available under an MIT-style license.
Copyright (c) 2005-2006 David Balmain
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.