Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 87 lines (47 sloc) 2.235 kb
c3f12a3 @brixen Made rspec a requirement of the build problem. Updated README and moved ...
brixen authored
1 1. What is Rubinius
5e250d3 @wilson Added a README file.
wilson authored
2
3a8ca30 @brixen Simplify README.
brixen authored
3 Rubinius is an implementation of the Ruby programming language.
4
5 Rubinius includes a bytecode virtual machine, parser, bytecode compiler,
6 garbage collector, and just-in-time (JIT) native machine code compiler. The
7 Ruby core library is written almost entirely in Ruby. Rubinius provides the
8 same standard libraries as Matz's Ruby implementation (MRI). Rubinius also
9 provides C-API compatibility for native C extensions.
db8e377 @brixen Updated README.
brixen authored
10
11 Rubinius currently is compatible with Ruby version 1.8.7. Support for Ruby
12 version 1.9.2 is coming soon.
d915c4c @brixen Updated README.
brixen authored
13
3a8ca30 @brixen Simplify README.
brixen authored
14 Rubinius runs on Mac OS X and many Unix/Linux operating systems. Support for
15 Microsoft Windows is coming soon.
5e250d3 @wilson Added a README file.
wilson authored
16
3a8ca30 @brixen Simplify README.
brixen authored
17 Most popular Ruby applications, like Rails, run on Rubinius.
5e250d3 @wilson Added a README file.
wilson authored
18
19
3a8ca30 @brixen Simplify README.
brixen authored
20 2. License
7f8477c @brixen Add license info and tweaks to README.
brixen authored
21
3a8ca30 @brixen Simplify README.
brixen authored
22 Rubinius uses the BSD license. See LICENSE for details.
d915c4c @brixen Updated README.
brixen authored
23
7f8477c @brixen Add license info and tweaks to README.
brixen authored
24
3a8ca30 @brixen Simplify README.
brixen authored
25 3. Installing Rubinius from Source
93abd2d Update the README for impatient people
Evan Phoenix authored
26
634291b @brixen Updated README with better directions for accessing docs.
brixen authored
27 To install Rubinius, use the following steps:
93abd2d Update the README for impatient people
Evan Phoenix authored
28
3a8ca30 @brixen Simplify README.
brixen authored
29 1. Ensure that MRI 1.8.7+, rubygems, rake, and git are installed
2a7ab2f @czarneckid Fixing README to point to Rubinius organization repository and GitHub is...
czarneckid authored
30 2. git clone git://github.com/rubinius/rubinius.git
634291b @brixen Updated README with better directions for accessing docs.
brixen authored
31 3. cd rubinius
32 4. ./configure --prefix=/path/to/install/dir
33 5. rake install
85a924d @dbussink Improve documentation on how to build with llvm enabled
dbussink authored
34
3a8ca30 @brixen Simplify README.
brixen authored
35 When the install process finishes, follow the directions printed to the
36 terminal to add the Rubinius executable (bin) directory to your PATH.
371feef @brixen Better install UX and README instructions. Closes #511.
brixen authored
37
3a8ca30 @brixen Simplify README.
brixen authored
38 For more information about building and running Rubinius, run 'rake docs'.
93abd2d Update the README for impatient people
Evan Phoenix authored
39
49a6498 @brixen Better docs on installing gems with rbx.
brixen authored
40
3a8ca30 @brixen Simplify README.
brixen authored
41 4. Installing Rubinius with RVM
49a6498 @brixen Better docs on installing gems with rbx.
brixen authored
42
0e73be8 Correct the full name of RVM in the README
Alexander Kern authored
43 Rubinius can be installed using the Ruby Version Manager (RVM) project.
49a6498 @brixen Better docs on installing gems with rbx.
brixen authored
44
3a8ca30 @brixen Simplify README.
brixen authored
45 To install Rubinius with RVM, use the following steps:
49a6498 @brixen Better docs on installing gems with rbx.
brixen authored
46
3a8ca30 @brixen Simplify README.
brixen authored
47 1. Ensure the latest RVM is installed
48 2. rvm install rbx-head
18066d4 @wayneeseguin Updated RVM section in Readme with more detail and clarity.
wayneeseguin authored
49
3a8ca30 @brixen Simplify README.
brixen authored
50 To use Rubinius in the current shell session, run:
18066d4 @wayneeseguin Updated RVM section in Readme with more detail and clarity.
wayneeseguin authored
51
3a8ca30 @brixen Simplify README.
brixen authored
52 rvm use rbx
18066d4 @wayneeseguin Updated RVM section in Readme with more detail and clarity.
wayneeseguin authored
53
3a8ca30 @brixen Simplify README.
brixen authored
54 To make Rubinius the default interpreter in new shells, run:
18066d4 @wayneeseguin Updated RVM section in Readme with more detail and clarity.
wayneeseguin authored
55
56 rvm use rbx --default
57
3a8ca30 @brixen Simplify README.
brixen authored
58 The documentation for RVM is available at:
18066d4 @wayneeseguin Updated RVM section in Readme with more detail and clarity.
wayneeseguin authored
59
3a8ca30 @brixen Simplify README.
brixen authored
60 https://rvm.beginrescueend.com
18066d4 @wayneeseguin Updated RVM section in Readme with more detail and clarity.
wayneeseguin authored
61
49a6498 @brixen Better docs on installing gems with rbx.
brixen authored
62
3a8ca30 @brixen Simplify README.
brixen authored
63 5. Using RubyGems
504682a @drbrain Merge stuff between cpp's README and master's, merge -C++ and -DEVELOPER...
drbrain authored
64
3a8ca30 @brixen Simplify README.
brixen authored
65 Rubinius comes with RubyGems built-in. To install a gem, run the following:
5e250d3 @wilson Added a README file.
wilson authored
66
3a8ca30 @brixen Simplify README.
brixen authored
67 rbx -S gem install <gem_name>
5e250d3 @wilson Added a README file.
wilson authored
68
69
3a8ca30 @brixen Simplify README.
brixen authored
70 6. Documentation
5e250d3 @wilson Added a README file.
wilson authored
71
3a8ca30 @brixen Simplify README.
brixen authored
72 After installing Rubinius, run 'rbx docs' to access the built-in documentation
73 at any time.
5e250d3 @wilson Added a README file.
wilson authored
74
90356d9 @brixen Docs on how to submit tickets.
brixen authored
75
3a8ca30 @brixen Simplify README.
brixen authored
76 7. Tickets
90356d9 @brixen Docs on how to submit tickets.
brixen authored
77
3a8ca30 @brixen Simplify README.
brixen authored
78 Please file tickets for bugs or problems. The issue tracker is:
5e250d3 @wilson Added a README file.
wilson authored
79
3a8ca30 @brixen Simplify README.
brixen authored
80 http://github.com/rubinius/rubinius/issues
5e250d3 @wilson Added a README file.
wilson authored
81
504682a @drbrain Merge stuff between cpp's README and master's, merge -C++ and -DEVELOPER...
drbrain authored
82
3a8ca30 @brixen Simplify README.
brixen authored
83 8. Contributing
504682a @drbrain Merge stuff between cpp's README and master's, merge -C++ and -DEVELOPER...
drbrain authored
84
634291b @brixen Updated README with better directions for accessing docs.
brixen authored
85 The Rubinius team welcomes contributions. Run 'rake docs' and see the
db8e377 @brixen Updated README.
brixen authored
86 "Contributing" page.
Something went wrong with that request. Please try again.