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 == Compiling Rubinius
  55
  56 Once you have all the prerequisites installed, building rubinius is as simple
  57 as:
  58
  59   cd /path/to/rubinius
  60   rake build
  61
  62 This will give you a binary, @./shotgun/rubinius@ which can then be invoked to
  63 run scripts. If your system compiler is not GCC 4.x, you can set the CC environment variable:
  64
  65   CC=/path/to/gcc rake build
  66
  67 If you want a development version (no optimisations, extra debug info), set the DEV environment variable:
  68
  69   DEV=1 rake build
  70
  71
  72 == Installing Rubinius
  73
  74 To install @rbx@ as a shortcut for @./shotgun/rubinius@:
  75
  76   rake install
  77
  78
  79 == Troubleshooting and platform-specific notes
  80
  81 Right now, the very best thing to do is to join the #rubinius IRC channel on
  82 irc://irc.freenode.net.  The forums here are an alternative method though the
  83 response is probably not going to be as swift. We will try to collect tips
  84 here, too.
  85
  86
  87 === 64-bit platforms
  88
  89 Currently mostly works on amd64 and Opteron. Other 64-bit platforms have not
  90 been tested.
  91
  92
  93 === Mac OS X with Fink
  94
  95 See http://42squared.com/posts/how_to_install_rubinius_on_mac_os_x
  96
  97 If you are getting an error like this one:
  98
  99   glibtool: link: cannot build libtool library `librubinius.la' from non-libtool objects: ...
 100
 101 This is probably because you are using an old glibtool (1.3.5 or similar) that
 102 came with Fink.  This is the case when `which glibtool` returns
 103 /sw/bin/glibtool. You want to use /usr/bin/glibtool (1.5) instead.  If you are
 104 radical you can just `sudo rm /sw/bin/glibtool` to fix this mess.
 105
 106
 107 === Ubuntu
 108
 109 For the build to succeed you will need these packages:
 110
 111 * libglib2.0-dev
 112 * zlib1g-dev
 113