Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'new-readme' of github.com:jruby/jruby
Conflicts: README.md
- Loading branch information
Showing
1 changed file
with
56 additions
and
37 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,62 +1,81 @@ | ||
| # JRuby - A Java implementation of the Ruby language | ||
| # JRuby - an implementation of the Ruby language on the JVM | ||
|
|
||
| Master: [](https://travis-ci.org/jruby/jruby) | ||
| 1.7 branch: [](https://travis-ci.org/jruby/jruby/branches) | ||
|
|
||
| Authors: Stefan Matthias Aust, Anders Bengtsson, Geert Bevin, Ola Bini, | ||
| Piergiuliano Bossi, Johannes Brodwall, Rocky Burt, Paul Butcher, | ||
| Benoit Cerrina, Wyss Clemens, David Corbin, Benoit Daloze, Thomas E Enebo, | ||
| Robert Feldt, Chad Fowler, Russ Freeman, Joey Gibson, Kiel Hodges, | ||
| Xandy Johnson, Kelvin Liu, Kevin Menard, Alan Moore, Akinori Musha, | ||
| Charles Nutter, Takashi Okamoto, Jan Arne Petersen, Tobias Reif, David Saff, | ||
| Subramanya Sastry, Chris Seaton, Nick Sieger, Ed Sinjiashvili, Vladimir Sizikov, | ||
| Daiki Ueno, Matthias Veit, Jason Voegele, Sergey Yevtushenko, Robert Yokota, | ||
| and many gracious contributors from the community. | ||
| ## About | ||
|
|
||
| Project Contact: Thomas E Enebo <tom.enebo@gmail.com> | ||
| JRuby is an implementation of the [Ruby language](http://www.ruby-lang.org) | ||
| using the JVM. | ||
|
|
||
| JRuby also uses code generously shared by the creator of the Ruby language, | ||
| Yukihiro Matsumoto <matz@netlab.co.jp>. | ||
| It aims to be a complete, correct and fast implementation of Ruby, at the same | ||
| time as providing powerful new features such as concurrency without a | ||
| [global-interpreter-lock](http://en.wikipedia.org/wiki/Global_Interpreter_Lock), | ||
| true parallelism, and tight integration to the Java language to allow you to | ||
| uses Java classes in your Ruby program and to allow JRuby to be embedded into a | ||
| Java application. | ||
|
|
||
| ## About | ||
| You can use JRuby simply as a faster version of Ruby, you can use it to run Ruby | ||
| on the JVM and access powerful JVM libraries such as highly tuned concurrency | ||
| primitives, you can use it to embed Ruby as a scripting language in your Java | ||
| program, or many other possibilites. | ||
|
|
||
| JRuby is the effort to recreate the Ruby (http://www.ruby-lang.org) interpreter | ||
| in Java. | ||
| We're a welcoming community - you can talk to us on [#jruby on Freenode](http://richard.esplins.org/siwi/2011/07/08/getting-started-freenode-irc/). | ||
| There are core team members in the EU and US time zones. | ||
|
|
||
| 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](docs) directory for more information. | ||
| Visit the [JRuby website](http://jruby.org) and the [JRuby wiki](https://github.com/jruby/jruby/wiki) | ||
| for more information. | ||
|
|
||
| ## Prerequisites | ||
| ## Getting JRuby | ||
|
|
||
| * A Java 7-compatible (or higher) Java development kit (JDK) | ||
| * Maven 3+ | ||
| * Apache Ant 1.8+ (see https://github.com/jruby/jruby/issues/2236) | ||
| To run JRuby you will need a JRE (the JVM runtime environment) version 7 or higher. | ||
|
|
||
| ## Run | ||
| Your operating system may provide a JRE and JRuby in a package manager, but you may find that this | ||
| version is very old. | ||
|
|
||
| bin/jruby rubyfile.rb | ||
| An alternative is to use one of the Ruby version managers. | ||
|
|
||
| interprets the file `rubyfile.rb`. | ||
| For [`rbenv`](https://github.com/sstephenson/rbenv) you will need the | ||
| [`ruby-build`](https://github.com/sstephenson/ruby-build) plugin. You may find that your system | ||
| package manager can provide these. Then you can run: | ||
|
|
||
| If you checked out from the repository or downloaded the source distribution, | ||
| see the next section to build JRuby first. | ||
| ``` | ||
| $ rbenv install rbenv install jruby-9.0.0.0-dev | ||
| ``` | ||
|
|
||
| ## Compiling from source | ||
| For [`rvm`](https://rvm.io) you can simply do: | ||
|
|
||
| See [BUILDING](BUILDING.md) for more information. | ||
| ``` | ||
| $ rvm install jruby | ||
| ``` | ||
|
|
||
| ## Testing | ||
| You can also [download packages from the JRuby website](http://jruby.org/download) that | ||
| you can unpack and run in place. | ||
|
|
||
| See [BUILDING: Developing and Testing](BUILDING.md#developing-and-testing) for | ||
| more information. | ||
| ## Building JRuby from source | ||
|
|
||
| ## More Information | ||
| See [BUILDING](BUILDING.md) for information about prerequisites, how to compile JRuby from source | ||
| and how to test it. | ||
|
|
||
| Visit http://jruby.org for more information. | ||
| ## Authors | ||
|
|
||
| Visit http://jruby.github.io/jruby for the Maven Site documentation. | ||
| Stefan Matthias Aust, Anders Bengtsson, Geert Bevin, Ola Bini, | ||
| Piergiuliano Bossi, Johannes Brodwall, Rocky Burt, Paul Butcher, | ||
| Benoit Cerrina, Wyss Clemens, David Corbin, Benoit Daloze, Thomas E Enebo, | ||
| Robert Feldt, Chad Fowler, Russ Freeman, Joey Gibson, Kiel Hodges, | ||
| Xandy Johnson, Kelvin Liu, Kevin Menard, Alan Moore, Akinori Musha, | ||
| Charles Nutter, Takashi Okamoto, Jan Arne Petersen, Tobias Reif, David Saff, | ||
| Subramanya Sastry, Chris Seaton, Nick Sieger, Ed Sinjiashvili, Vladimir Sizikov, | ||
| Daiki Ueno, Matthias Veit, Jason Voegele, Sergey Yevtushenko, Robert Yokota, | ||
| and many gracious contributors from the community. | ||
|
|
||
| JRuby uses code generously shared by the creator of the Ruby language, | ||
| Yukihiro Matsumoto <matz@netlab.co.jp>. | ||
|
|
||
| Project Contact: Thomas E Enebo <tom.enebo@gmail.com> | ||
|
|
||
| ## License | ||
|
|
||
| Read the [COPYING](COPYING) file. | ||
| JRuby is licensed to you under three licenses - the EPL 1.0, GPL 2 and LGPL 2.1. | ||
| Some components have other licenses and copyright. See the [COPYING](COPYING) | ||
| file for more specifics. |