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, 
 Ola Bini, Nick Sieger, Vladimir Sizikov, and many gracious contributions
 from the community.

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

JRuby also uses code generously shared by the creator of the Ruby language, 
Yukihiro Matsumoto <matz@netlab.co.jp>.

== About

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

The Java version is 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

    bin/jruby rubyfile.rb

interprets the file 'rubyfile.rb'.

If you checked out from the repository or downloaded the source distribution,
see the next section to build JRuby first.

== Compiling from source

You will need:

* JDK 1.5 or greater
* Apache Ant (http://jakarta.apache.org/ant/) 1.7 or greater.

To compile, just type:

    ant

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

== Testing

In order to run the unit tests, copy the build_lib/junit.jar file to either
$ANT_HOME/lib/junit.jar or ~/.ant/lib/junit.jar.

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

== More Information

Visit http://jruby.org for more information.

== License

Read the COPYING file.