Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 87 lines (51 sloc) 2.35 kb
7f71916 @brixen Updated README and added README.md.
brixen authored
1 1. The Rubinius Language Platform
5e250d3 @wilson Added a README file.
wilson authored
2
7f71916 @brixen Updated README and added README.md.
brixen authored
3 Rubinius is a modern language platform that supports a number of programming
4 languages.
3a8ca30 @brixen Simplify README.
brixen authored
5
7f71916 @brixen Updated README and added README.md.
brixen authored
6 Rubinius includes a bytecode virtual machine, generational garbage collector,
7 and just-in-time (JIT) native machine code compiler. Rubinius provides
8 concurrency support via native OS threads with no global interpreter lock.
db8e377 @brixen Updated README.
brixen authored
9
7f71916 @brixen Updated README and added README.md.
brixen authored
10 Rubinius runs on Mac OS X and many Unix/Linux operating systems. Microsoft
11 Windows is not yet supported.
12
13
14 2. The Ruby Programming Language
15
16 Many popular Ruby applications, like Rails, run on Rubinius, which aims to be
17 compatible with Ruby version 2.1.
18
19 Rubinius includes a Ruby parser, Ruby bytecode compiler, Ruby core library,
20 and C-API compatibility for native C extensions. The Ruby core library is
21 written almost entirely in Ruby. The Ruby bytecode compiler and other tools,
22 such as the debugger, are also written in Ruby. Rubinius provides the
23 standard Ruby libraries, with the following exceptions:
76bbe50 @sferik Note that not all standard libraries are implemented [ci skip]
sferik authored
24
1efe9f1 @sferik Add Continuation to the list of unimplemented libs [ci skip]
sferik authored
25 * Continuation
76bbe50 @sferik Note that not all standard libraries are implemented [ci skip]
sferik authored
26 * Ripper
8c1309f @sferik Add TracePoint to the list of unimplemented libs [ci skip]
sferik authored
27 * TracePoint
37fb2da @sferik Add Tracer to the list of unimplemented libs [ci skip]
sferik authored
28 * Tracer
d915c4c @brixen Updated README.
brixen authored
29
7f71916 @brixen Updated README and added README.md.
brixen authored
30 The following Ruby features are not supported on Rubinius:
5e250d3 @wilson Added a README file.
wilson authored
31
7f71916 @brixen Updated README and added README.md.
brixen authored
32 * Refinements
33 * $SAFE levels
5e250d3 @wilson Added a README file.
wilson authored
34
35
7f71916 @brixen Updated README and added README.md.
brixen authored
36 3. License
7f8477c @brixen Add license info and tweaks to README.
brixen authored
37
3a8ca30 @brixen Simplify README.
brixen authored
38 Rubinius uses the BSD license. See LICENSE for details.
d915c4c @brixen Updated README.
brixen authored
39
7f8477c @brixen Add license info and tweaks to README.
brixen authored
40
7f71916 @brixen Updated README and added README.md.
brixen authored
41 4. Installing Rubinius from Source
93abd2d Update the README for impatient people
Evan Phoenix authored
42
634291b @brixen Updated README with better directions for accessing docs.
brixen authored
43 To install Rubinius, use the following steps:
93abd2d Update the README for impatient people
Evan Phoenix authored
44
c64bb0a @YorickPeterse Added README note on LLVM.
YorickPeterse authored
45 1. Ensure that MRI 2.0+, rubygems, rake, git and LLVM are installed
2a7ab2f @czarneckid Fixing README to point to Rubinius organization repository and GitHub…
czarneckid authored
46 2. git clone git://github.com/rubinius/rubinius.git
634291b @brixen Updated README with better directions for accessing docs.
brixen authored
47 3. cd rubinius
6ff36cf @brixen Updated README.
brixen authored
48 4. bundle
49 5. ./configure --prefix=/path/to/install/dir
50 6. rake
85a924d @dbussink Improve documentation on how to build with llvm enabled
dbussink authored
51
3a8ca30 @brixen Simplify README.
brixen authored
52 When the install process finishes, follow the directions printed to the
c64bb0a @YorickPeterse Added README note on LLVM.
YorickPeterse authored
53 terminal to add the Rubinius executable (bin) directory to your PATH. For more
54 information see http://rubini.us/doc/en/getting-started/requirements/
55 and http://rubini.us/doc/en/getting-started/building/.
371feef @brixen Better install UX and README instructions. Closes #511.
brixen authored
56
49a6498 @brixen Better docs on installing gems with rbx.
brixen authored
57
7f71916 @brixen Updated README and added README.md.
brixen authored
58 5. Using RubyGems
504682a @drbrain Merge stuff between cpp's README and master's, merge -C++ and -DEVELO…
drbrain authored
59
3a8ca30 @brixen Simplify README.
brixen authored
60 Rubinius comes with RubyGems built-in. To install a gem, run the following:
5e250d3 @wilson Added a README file.
wilson authored
61
7f71916 @brixen Updated README and added README.md.
brixen authored
62 $ rbx -S gem install <gem_name>
63
5e250d3 @wilson Added a README file.
wilson authored
64
7f71916 @brixen Updated README and added README.md.
brixen authored
65 6. Documentation
5e250d3 @wilson Added a README file.
wilson authored
66
7f71916 @brixen Updated README and added README.md.
brixen authored
67 The Rubinius documentation is available at the Rubinius website:
5e250d3 @wilson Added a README file.
wilson authored
68
7f71916 @brixen Updated README and added README.md.
brixen authored
69 http://rubini.us
5e250d3 @wilson Added a README file.
wilson authored
70
90356d9 @brixen Docs on how to submit tickets.
brixen authored
71
7f71916 @brixen Updated README and added README.md.
brixen authored
72 7. Issues & Support
90356d9 @brixen Docs on how to submit tickets.
brixen authored
73
3a8ca30 @brixen Simplify README.
brixen authored
74 Please file tickets for bugs or problems. The issue tracker is:
5e250d3 @wilson Added a README file.
wilson authored
75
3a8ca30 @brixen Simplify README.
brixen authored
76 http://github.com/rubinius/rubinius/issues
5e250d3 @wilson Added a README file.
wilson authored
77
7f71916 @brixen Updated README and added README.md.
brixen authored
78 For additional help, visit the Rubinius Gitter chat room:
504682a @drbrain Merge stuff between cpp's README and master's, merge -C++ and -DEVELO…
drbrain authored
79
7f71916 @brixen Updated README and added README.md.
brixen authored
80 https://gitter.im/rubinius/rubinius
2ffd173 @YorickPeterse README section on unsupported features.
YorickPeterse authored
81
82
7f71916 @brixen Updated README and added README.md.
brixen authored
83 8. Contributing
2ffd173 @YorickPeterse README section on unsupported features.
YorickPeterse authored
84
7f71916 @brixen Updated README and added README.md.
brixen authored
85 The Rubinius team welcomes contributions. For more information, read the
86 CONTRIBUTING file in the root directory of Rubinius.
Something went wrong with that request. Please try again.