README

JRuby -  A Java implementation of the Ruby language

Authors: Stefan Matthias Aust, Anders Bengtsson, Geert Bevin,
 Piergiuliano Bossi, Johannes Brodwall, Rocky Burt, Paul Butcher,
 Benoit Cerrina, Wyss Clemens, David Corbin, Thomas E Enebo, Robert Feldt,
 Russ Freeman, Chad Fowler, Joey Gibson, Kiel Hodges, Xandy Johnson,
 Kelvin Liu, Alan Moore, Akinori Musha, Charles Nutter, Takashi Okamoto
 Jan Arne Petersen, Tobias Reif, David Saff, Ed Sinjiashvili, Daiki Ueno
 Matthias Veit, Jason Voegele, Sergey Yevtushenko, Robert Yokota

Project Contact: Thomas E Enebo <enebo@acm.org>

We also use some code created by Yukihiro Matsumoto <matz@netlab.co.jp>.

JRuby is the effort to recreate the Ruby (http://www.ruby-lang.org) interpreter
in Java.

The Java version is be tightly integrated with Java to allow both to script
any Java class and to embed the interpreter into any Java application. 
See the 'docs' directory for more information.


Run
===

    java -jar jruby.jar rubyfile.rb

interprets the file 'rubyfile.rb'.

Some globals depend on particular java properties to be set, so you
may need to use on the utility scripts: 'jruby.sh', 'jruby.rb' or 'jruby.bat'
to execute JRuby.


Compiling from source
=====================

You will need:

* JDK 1.4
* Apache Ant (http://jakarta.apache.org/ant/).

To compile, just type:

    ant

This will create a jruby.jar file in the projects 'lib' directory.


Testing
=======

See 'docs/README.test' for more information.


More Information
================

Visit http://jruby.sourceforge.net for more information.

License
=======

Read the COPYING file.