| 1 | ############################################################################### |
|---|
| 2 | # Files # |
|---|
| 3 | ############################################################################### |
|---|
| 4 | |
|---|
| 5 | There are some files you can run or look at just to get started: |
|---|
| 6 | |
|---|
| 7 | README.DIR This document. |
|---|
| 8 | README Basic information about REXML. |
|---|
| 9 | bin/ Several scripts for testing, installing, and |
|---|
| 10 | repackaging REXML. See bin/README. The short |
|---|
| 11 | of the long is that you run the scripts in bin/ |
|---|
| 12 | from the main directory... EG: "ruby bin/install.rb" |
|---|
| 13 | documentation.xml The base REXML documentation. |
|---|
| 14 | index.html documentation.xml converted to HTML |
|---|
| 15 | tutorial.html docs/tutorial.xml converted to HTML |
|---|
| 16 | LICENSE.txt The REXML license |
|---|
| 17 | GPL.txt The GPL, a fallback license |
|---|
| 18 | docs/ Documentation sources, and other development docs |
|---|
| 19 | doc/ API documentation |
|---|
| 20 | api/ The directory containing the API documentation |
|---|
| 21 | (in the works). |
|---|
| 22 | rexml/ The REXML package (IE, the sources) |
|---|
| 23 | benchmark/ Contains the benchmarking programs. |
|---|
| 24 | See benchmark/README. |
|---|
| 25 | contrib/ User contributions |
|---|
| 26 | img/ Images |
|---|
| 27 | test/ Files used by the test suite |
|---|
| 28 | |
|---|
| 29 | |
|---|
| 30 | Any other files are purely detria. Specifically, sometimes a test.rb file |
|---|
| 31 | makes its way into the repository; you can ignore these files. |
|---|
| 32 | |
|---|
| 33 | All of the files in this project but two were written in vim, with the following |
|---|
| 34 | tab settings: |
|---|
| 35 | |
|---|
| 36 | set ts=2 sw=2 |
|---|
| 37 | |
|---|
| 38 | These are the standard Ruby tabstops. The XML documents (the documentation and |
|---|
| 39 | tutorial) are maintained using XXE (www.xmlmind.com). |
|---|
| 40 | |
|---|
| 41 | Please see the documentation for more information. |
|---|
| 42 | |
|---|
| 43 | --- SER |
|---|