Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 81 lines (51 sloc) 2.742 kb
c3f12a3 Brian Shirai Made rspec a requirement of the build problem. Updated README and moved ...
brixen authored
1 1. What is Rubinius
5e250d3 Wilson Bilkovich Added a README file.
wilson authored
2
d915c4c Brian Shirai 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 Brian Shirai 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 Brian Shirai Updated README.
brixen authored
10
5e250d3 Wilson Bilkovich Added a README file.
wilson authored
11
7f8477c Brian Shirai Add license info and tweaks to README.
brixen authored
12 2. License
5e250d3 Wilson Bilkovich Added a README file.
wilson authored
13
7f8477c Brian Shirai Add license info and tweaks to README.
brixen authored
14 Rubinius uses the BSD license. See LICENSE for details.
5e250d3 Wilson Bilkovich Added a README file.
wilson authored
15
7f8477c Brian Shirai Add license info and tweaks to README.
brixen authored
16
d915c4c Brian Shirai Updated README.
brixen authored
17 3. Installing Rubinius
18
69cedd4 Dirkjan Bussink 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 Brian Shirai Add license info and tweaks to README.
brixen authored
21
634291b Brian Shirai 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 Brian Shirai 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 Brian Shirai 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 Dirkjan Bussink Improve documentation on how to build with llvm enabled
dbussink authored
31
371feef Brian Shirai Better install UX and README instructions. Closes #511.
brixen authored
32 When the install process finishes, follow the directions to add the Rubinius
33 executable (bin) directory to you PATH.
34
35 After installing Rubinius, you can access the built-in documentation at any
36 time by running 'rbx docs'.
93abd2d Update the README for impatient people
Evan Phoenix authored
37
db8e377 Brian Shirai Updated README.
brixen authored
38 4. Version 1.1
93abd2d Update the README for impatient people
Evan Phoenix authored
39
d915c4c Brian Shirai Updated README.
brixen authored
40 Rubinius has been under development as a public open-source project since
41 November 2006. Rubinius development is sponsored by Engine Yard, Inc. and
42 assisted by the generous work of over 100 contributors.
93abd2d Update the README for impatient people
Evan Phoenix authored
43
db8e377 Brian Shirai Updated README.
brixen authored
44 At version 1.1, Rubinius is significantly feature-complete. It is expected
d915c4c Brian Shirai Updated README.
brixen authored
45 that your Ruby code will run correctly. Additionally, many MRI C extensions
46 are expected to work, as long as they do not depend on MRI-specific object
47 internals or the MRI interpreter internals.
5e250d3 Wilson Bilkovich Added a README file.
wilson authored
48
d915c4c Brian Shirai Updated README.
brixen authored
49 With the JIT, Rubinius performance is quite good, sometimes faster than MRI
37c4e19 Brian Shirai Damn typos that only appear once the code is pushed.
brixen authored
50 and sometimes slower. Rubinius generally executes Ruby code very fast as
d915c4c Brian Shirai Updated README.
brixen authored
51 compared to MRI. However, since the majority of the Ruby core library is also
52 implemented in Ruby rather than C as it is in MRI, code that depends heavily
53 on Array, Hash, String, etc. may run slower in Rubinius right now. As the JIT
54 improves, overall performance of your code under Rubinius will improve.
504682a Eric Hodel Merge stuff between cpp's README and master's, merge -C++ and -DEVELOPER...
drbrain authored
55
5e250d3 Wilson Bilkovich Added a README file.
wilson authored
56
7f8477c Brian Shirai Add license info and tweaks to README.
brixen authored
57 5. Goals
5e250d3 Wilson Bilkovich Added a README file.
wilson authored
58
c3f12a3 Brian Shirai Made rspec a requirement of the build problem. Updated README and moved ...
brixen authored
59 * Thread safety. Rubinius intends to be thread-safe so you could embed more
8eb566a Fix docs a little
Evan Phoenix authored
60 than one interpreter in a single application.
5e250d3 Wilson Bilkovich Added a README file.
wilson authored
61
62 * Clean, readable code that is easy for users to understand and extend.
63
7f8477c Brian Shirai Add license info and tweaks to README.
brixen authored
64 * Reliable, rock-solid code. Valgrind is used to help verify correctness.
5e250d3 Wilson Bilkovich Added a README file.
wilson authored
65
d915c4c Brian Shirai Updated README.
brixen authored
66 * Bring modern research in virtual machines, garbage collectors, and compilers
67 to the Ruby programming language.
90356d9 Brian Shirai Docs on how to submit tickets.
brixen authored
68
69
d915c4c Brian Shirai Updated README.
brixen authored
70 6. Tickets
5e250d3 Wilson Bilkovich Added a README file.
wilson authored
71
d915c4c Brian Shirai Updated README.
brixen authored
72 Please file tickets for bugs or problems that you encounter. The issue tracker
634291b Brian Shirai Updated README with better directions for accessing docs.
brixen authored
73 is: http://github.com/evanphx/rubinius/issues. Run 'rake docs' for more
74 details.
5e250d3 Wilson Bilkovich Added a README file.
wilson authored
75
504682a Eric Hodel Merge stuff between cpp's README and master's, merge -C++ and -DEVELOPER...
drbrain authored
76
d915c4c Brian Shirai Updated README.
brixen authored
77 7. Contributing
504682a Eric Hodel Merge stuff between cpp's README and master's, merge -C++ and -DEVELOPER...
drbrain authored
78
634291b Brian Shirai Updated README with better directions for accessing docs.
brixen authored
79 The Rubinius team welcomes contributions. Run 'rake docs' and see the
db8e377 Brian Shirai Updated README.
brixen authored
80 "Contributing" page.
Something went wrong with that request. Please try again.