File: README — Documentation for rsi (0.4)

RSI README v0.4

RSI(Ruby Simple Indexer (or perhaps Really Simple Indexer)) is a
simple full text index.

RSI is a simple full text search engine implementation in Ruby.  It
aims to be easily useful within other programs: simple to set up,
simple to use.

An emphasis has been placed on getting functionality out the door,
rather than heavy optimization (that can come later).  It still
appears to be reasonably fast and efficient (while admitting to have
not been heavily profiled...).

Requirements

* Ruby 1.8

Install

De-compress archive and enter its top directory.
Then type:

 ($ su)
  # ruby setup.rb

These simple step installs this program under 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".

Usage

See rsi_intro.rb .

License

This is free software.
See the LICENSE file included in this distribution for terms.