Skip to content

Commit

Permalink
Change the focus of README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisseaton committed Apr 6, 2015
1 parent 30d1b93 commit 1a407ae
Showing 1 changed file with 47 additions and 37 deletions.
84 changes: 47 additions & 37 deletions README.md
@@ -1,62 +1,72 @@
# JRuby - An implementation of the Ruby language on the JVM
# JRuby - an implementation of the Ruby language on the JVM

Master: [![Build Status](https://travis-ci.org/jruby/jruby.png?branch=master)](https://travis-ci.org/jruby/jruby)
1.7 branch: [![Build Status](https://travis-ci.org/jruby/jruby.png?branch=jruby-1_7)](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 <enebo@acm.org>
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>.
JRuby aims to be a complete, correct and fast implementation of Ruby.

## About
As well as being a conventional Ruby interpreter, JRuby also has 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.

JRuby is an effort to implement the [Ruby language](http://www.ruby-lang.org)
on top of the JVM.
Visit the [JRuby website](http://jruby.org) and the [JRuby wiki](https://github.com/jruby/jruby/wiki)
for more information.

JRuby is tightly integrated with the JVM 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.
## Getting JRuby

## Prerequisites
To run JRuby you will need a JRE (the JVM runtime environment) version 7 or higher.

* A Java 7-compatible (or higher) Java development kit (JDK)
* Maven 3+
* Apache Ant 1.8+ (see https://github.com/jruby/jruby/issues/2236)
Your operating system may provide a JRE and JRuby in a package manager, but you may find that this
version is very old.

## Run
An alternative is to use one of the Ruby version managers.

bin/jruby 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:

interprets the file `rubyfile.rb`.
```
$ rbenv install rbenv install jruby-9.0.0.0-dev
```

If you checked out from the repository or downloaded the source distribution,
see the next section to build JRuby first.
For [`rvm`](https://rvm.io) you can simply do:

## Compiling from source
```
$ rvm install jruby
```

See [BUILDING](BUILDING.md) for more information.
You can also [download packages from the JRuby website](http://jruby.org/download) that
you can unpack and run in place.

## Testing
## Building JRuby from source

See [BUILDING: Developing and Testing](BUILDING.md#developing-and-testing) for
more information.
See [BUILDING](BUILDING.md) for information about prerequisites, how to compile JRuby from source
and how to test it.

## More Information
## Authors

Visit http://jruby.org for more information.
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.

Visit http://jruby.github.io/jruby for the Maven Site documentation.
JRuby uses code generously shared by the creator of the Ruby language,
Yukihiro Matsumoto <matz@netlab.co.jp>.

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

## 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.

0 comments on commit 1a407ae

Please sign in to comment.