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, Vladimir Sizikov, and many gracious contributions
  11  from the community.
  12
  13 Project Contact: Thomas E Enebo <enebo@acm.org>
  14
  15 JRuby also uses code generously shared by the creator of the Ruby language,
  16 Yukihiro Matsumoto <matz@netlab.co.jp>.
  17
  18 == About
  19
  20 JRuby is the effort to recreate the Ruby (http://www.ruby-lang.org) interpreter
  21 in Java.
  22
  23 The Java version is tightly integrated with Java to allow both to script
  24 any Java class and to embed the interpreter into any Java application.
  25 See the 'docs' directory for more information.
  26
  27 == Run
  28
  29     bin/jruby rubyfile.rb
  30
  31 interprets the file 'rubyfile.rb'.
  32
  33 == Compiling from source
  34
  35 You will need:
  36
  37 * JDK 1.5 or greater
  38 * Apache Ant (http://jakarta.apache.org/ant/) 1.7 or greater.
  39
  40 To compile, just type:
  41
  42     ant
  43
  44 This will create a jruby.jar file in the projects 'lib' directory.
  45
  46 == Testing
  47
  48 In order to run the unit tests, copy the build_lib/junit.jar file to either
  49 $ANT_HOME/lib/junit.jar or ~/.ant/lib/junit.jar.
  50
  51 See 'docs/README.test' for more information.
  52
  53 == More Information
  54
  55 Visit http://jruby.codehaus.org for more information.
  56
  57 == License
  58
  59 Read the COPYING file.