Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 116 lines (71 sloc) 3.871 kb
c3f12a3 @brixen Made rspec a requirement of the build problem. Updated README and mov…
brixen authored
1 1. What is Rubinius
5e250d3 @wilson Added a README file.
wilson authored
2
d915c4c @brixen Updated README.
brixen authored
3 Rubinius is an implementation of the Ruby programming language. Rubinius
4 includes a bytecode virtual machine, parser, bytecode compiler, garbage
5 collector, JIT native machine code compiler, and Ruby core and standard
db8e377 @brixen Updated README.
brixen authored
6 libraries.
7
8 Rubinius currently is compatible with Ruby version 1.8.7. Support for Ruby
9 version 1.9.2 is coming soon.
d915c4c @brixen Updated README.
brixen authored
10
5e250d3 @wilson Added a README file.
wilson authored
11
7f8477c @brixen Add license info and tweaks to README.
brixen authored
12 2. License
5e250d3 @wilson Added a README file.
wilson authored
13
7f8477c @brixen Add license info and tweaks to README.
brixen authored
14 Rubinius uses the BSD license. See LICENSE for details.
5e250d3 @wilson Added a README file.
wilson authored
15
7f8477c @brixen Add license info and tweaks to README.
brixen authored
16
d915c4c @brixen Updated README.
brixen authored
17 3. Installing Rubinius
18
69cedd4 @dbussink Fix typo's
dbussink authored
19 Rubinius runs on Mac OS X and many Unix/Linux operating systems. Support for
20 Microsoft Windows is coming soon.
7f8477c @brixen Add license info and tweaks to README.
brixen authored
21
634291b @brixen Updated README with better directions for accessing docs.
brixen authored
22 For more information about building and running Rubinius, run 'rake docs'.
93abd2d Update the README for impatient people
Evan Phoenix authored
23
634291b @brixen Updated README with better directions for accessing docs.
brixen authored
24 To install Rubinius, use the following steps:
93abd2d Update the README for impatient people
Evan Phoenix authored
25
634291b @brixen Updated README with better directions for accessing docs.
brixen authored
26 1. Ensure you have MRI 1.8.7+, rubygems, rake, and git installed
27 2. git clone git://github.com/evanphx/rubinius.git
28 3. cd rubinius
29 4. ./configure --prefix=/path/to/install/dir
30 5. rake install
85a924d @dbussink Improve documentation on how to build with llvm enabled
dbussink authored
31
371feef @brixen Better install UX and README instructions. Closes #511.
brixen authored
32 When the install process finishes, follow the directions to add the Rubinius
3209513 @brixen Fixed docs site install directions.
brixen authored
33 executable (bin) directory to your PATH.
371feef @brixen Better install UX and README instructions. Closes #511.
brixen authored
34
49a6498 @brixen Better docs on installing gems with rbx.
brixen authored
35 Rubinius comes with RubyGems built-in. To install a gem, run the following:
36
37 rbx gem install <gem_name>
38
371feef @brixen Better install UX and README instructions. Closes #511.
brixen authored
39 After installing Rubinius, you can access the built-in documentation at any
40 time by running 'rbx docs'.
93abd2d Update the README for impatient people
Evan Phoenix authored
41
18066d4 @wayneeseguin Updated RVM section in Readme with more detail and clarity.
wayneeseguin authored
42 3.1 Rubinius with RVM
49a6498 @brixen Better docs on installing gems with rbx.
brixen authored
43
18066d4 @wayneeseguin Updated RVM section in Readme with more detail and clarity.
wayneeseguin authored
44 You may wish to use the Ruby enVironment Manager (RVM) project to install
49a6498 @brixen Better docs on installing gems with rbx.
brixen authored
45 Rubinius. For the most current documentation for RVM, please visit
18066d4 @wayneeseguin Updated RVM section in Readme with more detail and clarity.
wayneeseguin authored
46 http://rvm.beginrescueend.com.
49a6498 @brixen Better docs on installing gems with rbx.
brixen authored
47
18066d4 @wayneeseguin Updated RVM section in Readme with more detail and clarity.
wayneeseguin authored
48 Be sure that RVM has been installed properly and is loaded as a function as is
49 explained in detail on the basics page, http://rvm.beginrescueend.com/rvm/basics/
49a6498 @brixen Better docs on installing gems with rbx.
brixen authored
50
18066d4 @wayneeseguin Updated RVM section in Readme with more detail and clarity.
wayneeseguin authored
51 Assuming all Rubinius dependencies have been preinstalled on the system, you may
52 now install Rubinius either latest or head as follows,
49a6498 @brixen Better docs on installing gems with rbx.
brixen authored
53
18066d4 @wayneeseguin Updated RVM section in Readme with more detail and clarity.
wayneeseguin authored
54 rvm install rbx # Installs latest release (defaulted to install head)
55 rvm install rbx-head # Installs Rubinius master branch from github
56
57 Once installed,
58
5709a64 @cypher Fix small typo in README
cypher authored
59 rvm use rbx # Selects Rubinius into the current shell session.
18066d4 @wayneeseguin Updated RVM section in Readme with more detail and clarity.
wayneeseguin authored
60
61 If you wish to make Rubinius the default interpreter when you open new shells,
62
63 rvm use rbx --default
64
65 In order to view the dependency list to preinstall for rbx type
66
67 rvm notes
68
69 For more information on working with rvm please visit the RVM website,
70
71 http://rvm.beginrescueend.com/
49a6498 @brixen Better docs on installing gems with rbx.
brixen authored
72
db8e377 @brixen Updated README.
brixen authored
73 4. Version 1.1
93abd2d Update the README for impatient people
Evan Phoenix authored
74
d915c4c @brixen Updated README.
brixen authored
75 Rubinius has been under development as a public open-source project since
76 November 2006. Rubinius development is sponsored by Engine Yard, Inc. and
77 assisted by the generous work of over 100 contributors.
93abd2d Update the README for impatient people
Evan Phoenix authored
78
db8e377 @brixen Updated README.
brixen authored
79 At version 1.1, Rubinius is significantly feature-complete. It is expected
d915c4c @brixen Updated README.
brixen authored
80 that your Ruby code will run correctly. Additionally, many MRI C extensions
81 are expected to work, as long as they do not depend on MRI-specific object
82 internals or the MRI interpreter internals.
5e250d3 @wilson Added a README file.
wilson authored
83
d915c4c @brixen Updated README.
brixen authored
84 With the JIT, Rubinius performance is quite good, sometimes faster than MRI
37c4e19 @brixen Damn typos that only appear once the code is pushed.
brixen authored
85 and sometimes slower. Rubinius generally executes Ruby code very fast as
d915c4c @brixen Updated README.
brixen authored
86 compared to MRI. However, since the majority of the Ruby core library is also
87 implemented in Ruby rather than C as it is in MRI, code that depends heavily
88 on Array, Hash, String, etc. may run slower in Rubinius right now. As the JIT
89 improves, overall performance of your code under Rubinius will improve.
504682a @drbrain Merge stuff between cpp's README and master's, merge -C++ and -DEVELO…
drbrain authored
90
5e250d3 @wilson Added a README file.
wilson authored
91
7f8477c @brixen Add license info and tweaks to README.
brixen authored
92 5. Goals
5e250d3 @wilson Added a README file.
wilson authored
93
c3f12a3 @brixen Made rspec a requirement of the build problem. Updated README and mov…
brixen authored
94 * Thread safety. Rubinius intends to be thread-safe so you could embed more
8eb566a Fix docs a little
Evan Phoenix authored
95 than one interpreter in a single application.
5e250d3 @wilson Added a README file.
wilson authored
96
97 * Clean, readable code that is easy for users to understand and extend.
98
7f8477c @brixen Add license info and tweaks to README.
brixen authored
99 * Reliable, rock-solid code. Valgrind is used to help verify correctness.
5e250d3 @wilson Added a README file.
wilson authored
100
d915c4c @brixen Updated README.
brixen authored
101 * Bring modern research in virtual machines, garbage collectors, and compilers
102 to the Ruby programming language.
90356d9 @brixen Docs on how to submit tickets.
brixen authored
103
104
d915c4c @brixen Updated README.
brixen authored
105 6. Tickets
5e250d3 @wilson Added a README file.
wilson authored
106
d915c4c @brixen Updated README.
brixen authored
107 Please file tickets for bugs or problems that you encounter. The issue tracker
634291b @brixen Updated README with better directions for accessing docs.
brixen authored
108 is: http://github.com/evanphx/rubinius/issues. Run 'rake docs' for more
109 details.
5e250d3 @wilson Added a README file.
wilson authored
110
504682a @drbrain Merge stuff between cpp's README and master's, merge -C++ and -DEVELO…
drbrain authored
111
d915c4c @brixen Updated README.
brixen authored
112 7. Contributing
504682a @drbrain Merge stuff between cpp's README and master's, merge -C++ and -DEVELO…
drbrain authored
113
634291b @brixen Updated README with better directions for accessing docs.
brixen authored
114 The Rubinius team welcomes contributions. Run 'rake docs' and see the
db8e377 @brixen Updated README.
brixen authored
115 "Contributing" page.
Something went wrong with that request. Please try again.