1. The Rubinius Language Platform

Rubinius is a modern language platform that supports a number of programming

languages.

Rubinius includes a bytecode virtual machine, generational garbage collector,

and just-in-time (JIT) native machine code compiler. Rubinius provides

concurrency support via native OS threads with no global interpreter lock.

Rubinius runs on Mac OS X and many Unix/Linux operating systems. Microsoft

Windows is not yet supported.

2. Code of Conduct

Participation in the Rubinius project is governed by the Rubinius Code of

Conduct. See https://rubinius.com/code-of-conduct/

3. The Ruby Programming Language

Many popular Ruby applications, like Rails, run on Rubinius, which aims to be

compatible with Ruby version 2.3.1.

Rubinius includes a Ruby parser, Ruby bytecode compiler, Ruby core library,

and C-API compatibility for native C extensions. The Ruby core library is

written almost entirely in Ruby. The Ruby bytecode compiler and other tools,

such as the debugger, are also written in Ruby. Rubinius provides the

standard Ruby libraries, with the following exceptions:

* Continuation

* Ripper

* TracePoint

* Tracer

The following Ruby features are not supported on Rubinius:

* Refinements

* $SAFE levels

4. License

All source code in this repository is subject to the terms of the Mozilla Public

License, version 2.0 unless stated otherwise. A copy of this license can be

found the file "LICENSE" or at https://www.mozilla.org/MPL/2.0/.

Contributions made prior to January 3rd, 2016 are licensed under the old BSD

3-clause license. A copy of this license can be found in the file "BSD_LICENSE".

In the event a directory contains a "LICENSE", "LICENSE.txt" or "COPYING" file

the license specified in said file applies to the contents of said directory and

all sub directories, overwriting the licenses specified above.

5. Installing Rubinius from Source

To install Rubinius, use the following steps:

1. Ensure that MRI 2.0+, rubygems, rake, git and LLVM are installed

2. git clone git://github.com/rubinius/rubinius.git

3. cd rubinius

4. ./build.sh --prefix=/path/to/install/dir

When the install process finishes, follow the directions printed to the

terminal to add the Rubinius executable (bin) directory to your PATH.

6. Using RubyGems

Rubinius comes with RubyGems built-in. To install a gem, run the following:

$ rbx -S gem install <gem_name>

7. Documentation

The Rubinius documentation is the Rubinius book:

https://rubinius.com/book/

8. Issues & Support

Please file tickets for bugs or problems. The issue tracker is:

https://github.com/rubinius/rubinius/issues

For additional help, visit the Rubinius Gitter chat room:

https://gitter.im/rubinius/rubinius

9. Contributing

The Rubinius team welcomes contributions. For more information, read the

.github/contributing.md file.