README

   1 JRuby -  A Java implementation of the Ruby language
   2
   3 Authors: Stefan Matthias Aust, Anders Bengtsson, Geert Bevin,
   4  Piergiuliano Bossi, Johannes Brodwall, Rocky Burt, Paul Butcher,
   5  Benoit Cerrina, Wyss Clemens, David Corbin, Thomas E Enebo, Robert Feldt,
   6  Russ Freeman, Chad Fowler, Joey Gibson, Kiel Hodges, Xandy Johnson,
   7  Kelvin Liu, Alan Moore, Akinori Musha, Charles Nutter, Takashi Okamoto
   8  Jan Arne Petersen, Tobias Reif, David Saff, Ed Sinjiashvili, Daiki Ueno
   9  Matthias Veit, Jason Voegele, Sergey Yevtushenko, Robert Yokota,
  10  Ola Bini, Nick Sieger, and many gracious contributions from the community.
  11
  12 Project Contact: Thomas E Enebo <enebo@acm.org>
  13
  14 JRuby also uses code generously shared by the creator of the Ruby language,
  15 Yukihiro Matsumoto <matz@netlab.co.jp>.
  16
  17 == About
  18
  19 JRuby is the effort to recreate the Ruby (http://www.ruby-lang.org) interpreter
  20 in Java.
  21
  22 The Java version is be tightly integrated with Java to allow both to script
  23 any Java class and to embed the interpreter into any Java application.
  24 See the 'docs' directory for more information.
  25
  26 == Run
  27
  28     bin/jruby rubyfile.rb
  29
  30 interprets the file 'rubyfile.rb'.
  31
  32 == Compiling from source
  33
  34 You will need:
  35
  36 * JDK 1.4 or greater
  37 * Apache Ant (http://jakarta.apache.org/ant/) 1.6.2 or greater.
  38
  39 To compile, just type:
  40
  41     ant
  42
  43 This will create a jruby.jar file in the projects 'lib' directory.
  44
  45 == Testing
  46
  47 In order to run the unit tests, copy the lib/junit.jar file to either
  48 $ANT_HOME/lib/junit.jar or ~/.ant/lib/junit.jar.
  49
  50 See 'docs/README.test' for more information.
  51
  52 == More Information
  53
  54 Visit http://jruby.codehaus.org for more information.
  55
  56 == License
  57
  58 Read the COPYING file.