- [change] '_out' is changed to '_buf'

- [change] option '-s' is obsolete
- [change] option '-E' is obsolete
- [change] option '-e' is renamed to '-E'
- [change] use command-line option object in Main class
- [refact] Helper#escape_xml() is changed to call String#gsub a time
- [change] test-bin.rb invoke Main.new.execute(), not 'ruby $script'

1 files changed, 80 insertions, 0 deletions

diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..61c6dbd
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,80 @@
+= README
+
+release::	$Release$
+copyright::	$Copyright$
+
+
+
+== About Erubis
+
+Erubis is an implementation of eRuby. It has the following features.
+* Very fast (about three times faster than ERB and almost as fast as eruby)
+* Auto trimming spaces around '<% %>'
+* Auto escape (sanitizing)
+* Changeable embedded pattern (default '<% %>')
+* Context object available
+* Easy to expand and customize in subclass
+* Multi-language support (Ruby/PHP/C/Java/Scheme/Perl/Javascript)
+
+Erubis is implemented in pure Ruby.  It requires Ruby 1.8 or higher.
+
+See doc/users-guide.html for details.
+
+
+
+== Installation
+
+* If you have installed RubyGems, just type <tt>gem install --remote erubis</tt>.
+
+    $ sudo gem install --remote erubis
+
+* Else install abstract[http://rubyforge.org/projects/abstract/] at first,
+  and download erubis_X.X.X.tar.bz2 and install it by setup.rb.
+
+    $ tar xjf abstract_X.X.X.tar.bz2
+    $ cd abstract_X.X.X/
+    $ sudo ruby setup.rb
+    $ cd ..
+    $ tar xjf erubis_X.X.X.tar.bz2
+    $ cd erubis_X.X.X/
+    $ sudo ruby setup.rb
+
+* (Optional) It is able to merge 'lib/**/*.rb' into 'bin/erubis' by
+  'contrib/inline-require' script.
+
+    $ tar xjf erubis_X.X.X.tar.bz2
+    $ cd erubis_X.X.X/
+    $ cp /tmp/abstract_X.X.X/lib/abstract.rb lib
+    $ unset RUBYLIB
+    $ contrib/inline-require -I lib bin/erubis > contrib/erubis
+
+
+
+== Exploring Guide
+
+If you are exploring Eruby, see the following class at first.
+* Erubis::TinyEruby (erubis/tiny.rb) --
+  the most simple eRuby implementation.
+* Erubis::Engine (erubis/engine.rb) --
+  base class of Eruby, Ephp, Ejava, and so on.
+* Erubis::Eruby (erubis/engine/eruby.rb) --
+  engine class for eRuby.
+
+
+
+== Benchmark
+
+'benchmark/erubybenchmark.rb' is a benchmark script of Erubis.
+Try 'ruby erubybenchmark.rb' in benchmark directory.
+
+
+
+== License
+
+GPL ver.2
+
+
+
+== Author
+
+makoto kuwata <kwa(at)kuwata-lab.com>