INSTALL

   1 = Installation guide for Rubinius as of 10/2007
   2
   3 If you are having trouble with installation, the #rubinius IRC channel on
   4 irc://irc.freenode.net will help.
   5
   6
   7 == Getting the software and required libraries
   8
   9 There are a few things that you need in order to be able to build and run
  10 Rubinius.  Once you have installed the general requirements, install the Gems
  11 needed and then any platform-specific requirements.
  12
  13
  14 === General requirements
  15
  16 * "GCC version 4.x":http://gcc.gnu.org/
  17 * "GNU Bison":http://www.gnu.org/software/bison/
  18 * "gmake (GNU Make)":http://savannah.gnu.org/projects/make/
  19 * "Ruby version >= 1.8.4 (the Ruby language)":http://www.ruby-lang.org/
  20 * "RubyGems (Ruby package manager)":http://www.rubygems.org/
  21 * "Git (source control used by rubinius)":http://git.or.cz/
  22
  23 Each package may have requirements of its own, of course.
  24
  25 If you want to avoid overriding your existing environment, you may want to
  26 install everything under its own prefix (such as /usr/local) and to name
  27 programs so they don't collide with your existing installation (such as naming
  28 gmake 'gmake').  You can then adjust your PATH environment variable as needed
  29 for rubinius development.
  30
  31
  32 === Requirements through RubyGems
  33
  34 * rake
  35
  36 Rake may be obtained with the `gem install` command. See `gem help` and
  37 http://www.rubygems.org for more information.
  38
  39
  40 == Rubinius itself
  41
  42 You need to check Rubinius out through Git (which we just installed). The
  43 invocation looks like this:
  44
  45   git clone http://git.rubini.us/code rubinius
  46
  47 For more information on rubinius' best practices for git, see "using
  48 git":http://rubinius.lighthouseapp.com/projects/5089/using-git
  49
  50 Rubinius can also be cloned via github:
  51
  52   git clone git://github.com/evanphx/rubinius.git rubinius
  53
  54 == Getting the RubySpec submodules
  55
  56 You need to fetch the source for MSpec and the RubySpec submodules manually.
  57 After running 'git clone' above, run:
  58
  59   rake spec:update
  60
  61 The spec:update task is also a dependency of the git:update task. So, if you
  62 use the rake tasks for updating your Rubinius sources, the MSpec and RubySpec
  63 source will automatically be updated. If you use the git commands manually,
  64 you will need to run rake spec:update also.
  65
  66 == Compiling Rubinius
  67
  68 Once you have all the prerequisites installed, building rubinius is as simple
  69 as:
  70
  71   cd /path/to/rubinius
  72   rake build
  73
  74 This will give you a binary, @./shotgun/rubinius@ which can then be invoked to
  75 run scripts. If your system compiler is not GCC 4.x, you can set the CC environment variable:
  76
  77   CC=/path/to/gcc rake build
  78
  79 If you want a development version (no optimisations, extra debug info), set the DEV environment variable:
  80
  81   DEV=1 rake build
  82
  83
  84 == Installing Rubinius
  85
  86 To install @rbx@ as a shortcut for @./shotgun/rubinius@:
  87
  88   rake install
  89
  90
  91 == Prefix installs
  92
  93 To install rbx and the rubinius library in a different location, you can set
  94 the PREFIX environment variable during build and install:
  95
  96   PREFIX=/opt/packages/rubinius rake build
  97   PREFIX=/opt/packages/rubinius rake install
  98
  99
 100 == Troubleshooting and platform-specific notes
 101
 102 Right now, the very best thing to do is to join the #rubinius IRC channel on
 103 irc://irc.freenode.net.  The forums here are an alternative method though the
 104 response is probably not going to be as swift. We will try to collect tips
 105 here, too.
 106
 107
 108 === 64-bit platforms
 109
 110 Currently mostly works on amd64 and Opteron. Other 64-bit platforms have not
 111 been tested.
 112
 113
 114 === Mac OS X with macports
 115
 116 See http://sam.aaron.name/2007/9/22/rubinius-on-os-x/
 117
 118 === Ubuntu
 119
 120 For the build to succeed you will need these packages:
 121
 122 * bison
 123 * libglib2.0-dev
 124 * libreadline5-dev
 125 * libssl-dev
 126 * zlib1g-dev