Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 71 lines (44 sloc) 2.377 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
7f8477c @brixen Add license info and tweaks to README.
brixen authored
3 Rubinius is an execution environment for the Ruby programming language. It is
4 comprised of three major pieces: a compiler, a 'kernel' (otherwise known as
5 the Ruby Core Library), and a virtual machine. The project's goal is to create
6 a top-of-the-line Ruby implementation.
5e250d3 @wilson Added a README file.
wilson authored
7
7f8477c @brixen Add license info and tweaks to README.
brixen authored
8 2. License
5e250d3 @wilson Added a README file.
wilson authored
9
7f8477c @brixen Add license info and tweaks to README.
brixen authored
10 Rubinius uses the BSD license. See LICENSE for details.
5e250d3 @wilson Added a README file.
wilson authored
11
7f8477c @brixen Add license info and tweaks to README.
brixen authored
12 3. Running Rubinius
13
14 See doc/getting_started.txt.
15
93abd2d Update the README for impatient people
Evan Phoenix authored
16 3.1. For the impatient
17
18 Now to configure with LLVM: "./configure --enable-llvm"
19
85a924d @dbussink Improve documentation on how to build with llvm enabled
dbussink authored
20 This will try to download a prebuilt version of llvm for your system. If it
21 can't find a prebuilt version, then it will at the very least checkout LLVM
22 from svn and built it during the next step (this takes a lot of time).
23
93abd2d Update the README for impatient people
Evan Phoenix authored
24 or
25
26 To configure without the JIT: "./configure"
27
28 Now: "rake"
29
7f8477c @brixen Add license info and tweaks to README.
brixen authored
30 4. Status
5e250d3 @wilson Added a README file.
wilson authored
31
504682a @drbrain Merge stuff between cpp's README and master's, merge -C++ and -DEVELO…
drbrain authored
32 Rubinius is under heavy development and currently supports the core Ruby
7f8477c @brixen Add license info and tweaks to README.
brixen authored
33 classes and kernel methods. The majority of the existing Ruby libraries should
34 run without modification. If your MRI 1.8.6-compatible code does not run
35 under Rubinius, please open a bug ticket. See doc/howto/write_a_ticket.txt.
504682a @drbrain Merge stuff between cpp's README and master's, merge -C++ and -DEVELO…
drbrain authored
36
37 As Rubinius becomes more and more compatible with Ruby 1.8, the development
38 effort is shifting toward performance, rather than completeness.
5e250d3 @wilson Added a README file.
wilson authored
39
7f8477c @brixen Add license info and tweaks to README.
brixen authored
40 5. Goals
5e250d3 @wilson Added a README file.
wilson authored
41
c3f12a3 @brixen Made rspec a requirement of the build problem. Updated README and mov…
brixen authored
42 * Thread safety. Rubinius intends to be thread-safe so you could embed more
90c05c1 @drbrain Update INSTALL to latest information.
drbrain authored
43 than one interpreter in a single application. It does not currently meet
8ad84f6 @evanphx Fix some spacing
evanphx authored
44 this goal due to some components borrowed from the mainline Ruby interpreter.
5e250d3 @wilson Added a README file.
wilson authored
45
46 * Clean, readable code that is easy for users to understand and extend.
47
7f8477c @brixen Add license info and tweaks to README.
brixen authored
48 * Reliable, rock-solid code. Valgrind is used to help verify correctness.
5e250d3 @wilson Added a README file.
wilson authored
49
c3f12a3 @brixen Made rspec a requirement of the build problem. Updated README and mov…
brixen authored
50 * Bring modern techniques to the Ruby runtime. Pluggable garbage collectors and
5e250d3 @wilson Added a README file.
wilson authored
51 code optimizers are possible examples.
52
90356d9 @brixen Docs on how to submit tickets.
brixen authored
53 6. Tickets
54
55 See doc/howto/write_a_ticket.txt
56
57 7. Contributing
5e250d3 @wilson Added a README file.
wilson authored
58
7f8477c @brixen Add license info and tweaks to README.
brixen authored
59 The Rubinius team welcomes contributions, bug reports, test cases, and
60 monetary support. One possible way to help is implement Ruby library classes.
61 See doc/contributing.txt to get started.
5e250d3 @wilson Added a README file.
wilson authored
62
90356d9 @brixen Docs on how to submit tickets.
brixen authored
63 8. Architecture
504682a @drbrain Merge stuff between cpp's README and master's, merge -C++ and -DEVELO…
drbrain authored
64
7f8477c @brixen Add license info and tweaks to README.
brixen authored
65 While most of the Rubinius features are implemented in Ruby, the VM itself is
66 written in C++. This is likely to continue to be the case in the coming
504682a @drbrain Merge stuff between cpp's README and master's, merge -C++ and -DEVELO…
drbrain authored
67 months, partly to ease the integration of LLVM into the Rubinius system.
68
69 The compiler, assembler, and bytecode generators are all written in Ruby, and
11294ce @brixen Update compiler location in README.
brixen authored
70 can be found under the ./kernel/compiler directory.
Something went wrong with that request. Please try again.