|
1 | | -# JRuby - An implementation of the Ruby language on the JVM |
| 1 | +# JRuby - an implementation of the Ruby language on the JVM |
2 | 2 |
|
3 | 3 | Master: [](https://travis-ci.org/jruby/jruby) |
4 | 4 | 1.7 branch: [](https://travis-ci.org/jruby/jruby/branches) |
5 | 5 |
|
6 | | -Authors: Stefan Matthias Aust, Anders Bengtsson, Geert Bevin, Ola Bini, |
7 | | - Piergiuliano Bossi, Johannes Brodwall, Rocky Burt, Paul Butcher, |
8 | | - Benoit Cerrina, Wyss Clemens, David Corbin, Benoit Daloze, Thomas E Enebo, |
9 | | - Robert Feldt, Chad Fowler, Russ Freeman, Joey Gibson, Kiel Hodges, |
10 | | - Xandy Johnson, Kelvin Liu, Kevin Menard, Alan Moore, Akinori Musha, |
11 | | - Charles Nutter, Takashi Okamoto, Jan Arne Petersen, Tobias Reif, David Saff, |
12 | | - Subramanya Sastry, Chris Seaton, Nick Sieger, Ed Sinjiashvili, Vladimir Sizikov, |
13 | | - Daiki Ueno, Matthias Veit, Jason Voegele, Sergey Yevtushenko, Robert Yokota, |
14 | | - and many gracious contributors from the community. |
| 6 | +## About |
15 | 7 |
|
16 | | -Project Contact: Thomas E Enebo <enebo@acm.org> |
| 8 | +JRuby is an implementation of the [Ruby language](http://www.ruby-lang.org) |
| 9 | +using the JVM. |
17 | 10 |
|
18 | | -JRuby also uses code generously shared by the creator of the Ruby language, |
19 | | -Yukihiro Matsumoto <matz@netlab.co.jp>. |
| 11 | +JRuby aims to be a complete, correct and fast implementation of Ruby. |
20 | 12 |
|
21 | | -## About |
| 13 | +As well as being a conventional Ruby interpreter, JRuby also has tight integration |
| 14 | +to the Java language to allow you to uses Java classes in your Ruby program and |
| 15 | +to allow JRuby to be embedded into a Java application. |
22 | 16 |
|
23 | | -JRuby is an effort to implement the [Ruby language](http://www.ruby-lang.org) |
24 | | -on top of the JVM. |
| 17 | +Visit the [JRuby website](http://jruby.org) and the [JRuby wiki](https://github.com/jruby/jruby/wiki) |
| 18 | +for more information. |
25 | 19 |
|
26 | | -JRuby is tightly integrated with the JVM to allow both to script |
27 | | -any Java class and to embed the interpreter into any Java application. |
28 | | -See the [docs](docs) directory for more information. |
| 20 | +## Getting JRuby |
29 | 21 |
|
30 | | -## Prerequisites |
| 22 | +To run JRuby you will need a JRE (the JVM runtime environment) version 7 or higher. |
31 | 23 |
|
32 | | -* A Java 7-compatible (or higher) Java development kit (JDK) |
33 | | -* Maven 3+ |
34 | | -* Apache Ant 1.8+ (see https://github.com/jruby/jruby/issues/2236) |
| 24 | +Your operating system may provide a JRE and JRuby in a package manager, but you may find that this |
| 25 | +version is very old. |
35 | 26 |
|
36 | | -## Run |
| 27 | +An alternative is to use one of the Ruby version managers. |
37 | 28 |
|
38 | | - bin/jruby rubyfile.rb |
| 29 | +For [`rbenv`](https://github.com/sstephenson/rbenv) you will need the |
| 30 | +[`ruby-build`](https://github.com/sstephenson/ruby-build) plugin. You may find that your system |
| 31 | +package manager can provide these. Then you can run: |
39 | 32 |
|
40 | | -interprets the file `rubyfile.rb`. |
| 33 | +``` |
| 34 | +$ rbenv install rbenv install jruby-9.0.0.0-dev |
| 35 | +``` |
41 | 36 |
|
42 | | -If you checked out from the repository or downloaded the source distribution, |
43 | | -see the next section to build JRuby first. |
| 37 | +For [`rvm`](https://rvm.io) you can simply do: |
44 | 38 |
|
45 | | -## Compiling from source |
| 39 | +``` |
| 40 | +$ rvm install jruby |
| 41 | +``` |
46 | 42 |
|
47 | | -See [BUILDING](BUILDING.md) for more information. |
| 43 | +You can also [download packages from the JRuby website](http://jruby.org/download) that |
| 44 | +you can unpack and run in place. |
48 | 45 |
|
49 | | -## Testing |
| 46 | +## Building JRuby from source |
50 | 47 |
|
51 | | -See [BUILDING: Developing and Testing](BUILDING.md#developing-and-testing) for |
52 | | -more information. |
| 48 | +See [BUILDING](BUILDING.md) for information about prerequisites, how to compile JRuby from source |
| 49 | +and how to test it. |
53 | 50 |
|
54 | | -## More Information |
| 51 | +## Authors |
55 | 52 |
|
56 | | -Visit http://jruby.org for more information. |
| 53 | +Stefan Matthias Aust, Anders Bengtsson, Geert Bevin, Ola Bini, |
| 54 | + Piergiuliano Bossi, Johannes Brodwall, Rocky Burt, Paul Butcher, |
| 55 | + Benoit Cerrina, Wyss Clemens, David Corbin, Benoit Daloze, Thomas E Enebo, |
| 56 | + Robert Feldt, Chad Fowler, Russ Freeman, Joey Gibson, Kiel Hodges, |
| 57 | + Xandy Johnson, Kelvin Liu, Kevin Menard, Alan Moore, Akinori Musha, |
| 58 | + Charles Nutter, Takashi Okamoto, Jan Arne Petersen, Tobias Reif, David Saff, |
| 59 | + Subramanya Sastry, Chris Seaton, Nick Sieger, Ed Sinjiashvili, Vladimir Sizikov, |
| 60 | + Daiki Ueno, Matthias Veit, Jason Voegele, Sergey Yevtushenko, Robert Yokota, |
| 61 | + and many gracious contributors from the community. |
57 | 62 |
|
58 | | -Visit http://jruby.github.io/jruby for the Maven Site documentation. |
| 63 | +JRuby uses code generously shared by the creator of the Ruby language, |
| 64 | +Yukihiro Matsumoto <matz@netlab.co.jp>. |
| 65 | + |
| 66 | +Project Contact: Thomas E Enebo <enebo@acm.org> |
59 | 67 |
|
60 | 68 | ## License |
61 | 69 |
|
62 | | -Read the [COPYING](COPYING) file. |
| 70 | +JRuby is licensed to you under three licenses - the EPL 1.0, GPL 2 and LGPL 2.1. |
| 71 | +Some components have other licenses and copyright. See the [COPYING](COPYING) |
| 72 | +file for more specifics. |
0 commit comments