root / bin / FILES

Revision 206:b66d3242f248, 2.1 kB (checked in by ser, 6 years ago)

* Changed the unit tests to match new data source
* Made write() send to $stdout by default; this means that argument #1 is

no longer required.

* Some documentation fixes
* When a child was added to a parent, the parent wasn't making sure that the

child was removed from any previous parent. This has been fixed.

* ##### WARNING: API CHANGE #####

Attlist declarations have been improved.
This affects StreamListener?

* ##### WARNING: API CHANGE #####

@element in AttlistDecl? is now @element_name

* Many READMEs were really file lists, and have been renamed to FILES
* There's a nacent INSTALL in the root directory now, on user request.

Line 
1###############################################################################
2#                                    Files                                    #
3###############################################################################
4
5There are some files you can run or look at just to get started:
6
7   install.rb           Run this to install REXML
8   suite.rb             A unit test suite.  You must have runit (or
9                        test/unit) installed to run this.  If you want
10                        to run it before you install REXML, use
11                        "ruby -I. suite.rb".
12   repackage.rb         This script builds a distribution that you can
13                              include with your applications.  It contains a
14                        directory with the REXML files, a short README,
15                        and the REXML licenses.  This is the minimum
16                        REXML redistribution package.
17         upgrade.rb           This is not for you.  Ignore this file.  All this
18                        script does is change the versions and dates in
19                        several files in the distribution.
20   Oasis.rb             A script to run XML parsers against the Oasis test
21                        suite.  Read the top of the file for more information
22                        about running the script; at the very least, you have
23                        to tell the script where the Oasis tests are.
24
25If you have ruby in your path, you should be able to execute any of the
26.rb files, although some of them may not run if you don't have certain
27packages installed.  Run these from the main REXML directory; IE, call
28them like "bin/install.rb" or "ruby bin/repackage.rb".
29
30If you want to run these programs without installing REXML, you must make
31sure that REXML is in your include path.  For example:
32
33   ruby -I. bin/suite.rb
34
35If you want to include REXML in your application, run repackage.rb and
36include the resulting rexml_dist directory in your distribution.  Make
37sure that your distribution either installs REXML, or that your application
38includes the rexml_dist directory in the Ruby include path.
39
40--- SER
Note: See TracBrowser for help on using the browser.