REXML is an XML parser for Ruby, in Ruby.
URL: http://www.germane-software.com/~ser/software/rexml
Author: Sean Russell <ser@germane-software.com>
Version: 1.1a


###############################################################################
#                                    Files                                    #
###############################################################################

There are some files you can run or look at just to get started:

   README               This document
   LICENSE.txt          The REXML license
   GPL.txt              The GPL, a fallback license
   install.rb           Run this to install REXML
   suite.rb             A unit test suite.  You must have junit installed
                        to run this.
   profile.rb           A profiling suite, using Ruby's profile module
   documentation.xml    The XML source of the documentation, and the index
                        page for REXML's home page.
   index.html           documentation.xml converted to HTML
   tutorial.xml         The XML source for the tutorial
   tutorial.html        tutorial.xml converted to HTML
   api/                 The directory containing the API documentation
                        (in the works).
   rb/                  Where I had the sources originally, now contains
                        whatever doesn't belong in the rexml directory;
                        most, it holds the project.xml file, which is the
                        unit test suite's XML file source.  I'd remove this
                        directory, but moving directories in CVS is a pain,
                        and I'm too lazy.  You can ignore this directory.
   rexml/               The REXML package (IE, the sources)
   benchmark/           Contains the benchmarking programs

Any other files are purely detria.  Specifically, sometimes a test.rb file
makes its way into the repository; you can ignore these files.

If you have ruby in your path, you should be able to execute any of the
.rb files, although some of them may not run if you don't have certain
packages installed.

If you want to run these programs without installing REXML, you must make
sure that REXML is in your include path.  For example:

   ruby -I. suite.rb

If you want to include REXML in your application, you can simply copy
the rexml subdirectory to your application directory, and make sure that
it is in your include path.

Please see the documentation for more information.

--- SER
*2001-295
