README

   1 1. What is Rubinius
   2
   3 Rubinius is a next-generation virtual machine and compiler for Ruby.  Based
   4 loosely on the Smalltalk-80 'Blue Book' design, Rubinius will provide a rich,
   5 high-performance environment for running Ruby code.
   6
   7 2. Running Rubinius
   8
   9 Refer to the INSTALL file for instructions on getting and building Rubinius.
  10
  11 3. Status
  12
  13 Rubinius is under heavy development, and currently supports the basic Ruby
  14 classes and kernel methods. The code base is written in a mixture of ANSI C and
  15 Ruby; with more Ruby and less C as the project proceeds.  You should not run
  16 your mission-critical Rails apps under Rubinius yet.
  17
  18 4. Goals
  19
  20 * Thread safety. Rubinius intends to be thread-safe so you could embed more
  21   than one interpreter in a single application. It does not currently meet
  22   this goal due to some components borrowed from the mainline Ruby interpreter.
  23
  24 * Clean, readable code that is easy for users to understand and extend.
  25
  26 * Reliable, rock-solid code.  Valgrind is used to help verify correctness.
  27
  28 * Bring modern techniques to the Ruby runtime. Pluggable garbage collectors and
  29   code optimizers are possible examples.
  30
  31 5. Volunteering to Help
  32
  33 The Rubinius team welcomes contributions, bug reports, test cases, and monetary
  34 support. One possible way to help is implement Ruby library classes. Visit
  35 http://rubinius.lighthouseapp.com for documentation on how to begin hacking
  36 Rubinius.
  37
  38 6. Architecture
  39
  40 Rubinius currently uses C to bootstrap the system. In the future, a limited
  41 dialect of Ruby called cuby/garnet will be used to generate C. This is a
  42 time-honored technique, used by systems such as Squeak, Smalltalk, and Algol on
  43 the Burroughs systems (as seen in the movie 'Tron').
  44
  45 For now, this code is hand-written, and can be found in the ./shotgun/lib
  46 directory.  This code was ported from a Ruby implementation found in the ./lib
  47 directory.  For example, shotgun/lib/object_memory.c is the C translation of
  48 lib/object_memory.rb.
  49
  50 The compiler, assembler, and bytecode generators are all written in Ruby, and
  51 can be found under the ./lib directory.  Other systems use the word
  52 'translator' for what is here referred to as 'compiler'.  The ./bin/rcc script
  53 can be used to display the symbolic output of the compiler, for debugging or
  54 learning purposes.
  55