README

Path: README  (CVS)
Last Update: Thu Sep 08 01:32:12 MDT 2005

OOParser

Version 0.0.1 - 2005/09/07 by Michael Granger <ged@FaerieMUD.org>

Description

OOParser is a base class for writing object-oriented parsers in Ruby.

(More later)

Installation

You can install this module either by running the included `install.rb` script, or by simply copying `lib/ooparser*’ to somewhere in your Ruby include path.

Dependencies

OOParser uses the `StringScanner` class from the `strscan` library, which comes with Ruby 1.8.x and later or may be downloaded from the RAA for earlier versions, and the `logger` library, which is also included in 1.8.x and later.

Example Usage

(later)

Acknowledgements

This library is heavily inspired by the work of Damian Conway. Much of the ideas for this library come from those found in his Perl modules, including Parse::RecDescent, Perl6::Rules, and Text::Balanced. My thanks to him for inspiration for this and other projects.

Author/Legal

This module is Open Source Software which is Copyright © 2003-2005 by The FaerieMUD Consortium.

You may use, modify, and/or redistribute this software under the same terms as Ruby itself.

This software is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

  $Id: README 75 2005-05-12 20:31:10Z ged $
  $URL: svn+ssh://svn.FaerieMUD.org/var/svn/BlueCloth/trunk/README $

[Validate]