Browse files

Fix doxygen dir in .gitignore. Updated INSTALL for probably no purpose.

  • Loading branch information...
rue committed Oct 20, 2008
1 parent 6fd8259 commit 0e13a429e16aa4af96cce0137dae55a0edb29050
Showing with 30 additions and 48 deletions.
  1. +1 −1 .gitignore
  2. +29 −47 INSTALL
@@ -97,4 +97,4 @@ vm/external_libs/llvm/tools/Makefile
# Generated documentation
@@ -1,4 +1,4 @@
-= Installation guide for Rubinius as of 10/2007
+= Installation guide for Rubinius as of 10/2008
If you are having trouble with installation, the #rubinius IRC channel on
irc:// will help.
@@ -13,15 +13,17 @@ needed and then any platform-specific requirements.
=== General requirements
-* "GCC version 4.x":
+* "GCC 4.x (both g++ and gcc)":
* "GNU Bison":
-* "gmake (GNU Make)":
-* "pkg-config (configuration tool)":
-* "libtool version >= 1.5":
* "Ruby version >= 1.8.4 (the Ruby language)":
* "RubyGems (Ruby package manager)":
* "Git (source control used by rubinius)":
-* "zip and unzip commands (archiving)":
+* "zlib compression library":
+Most systems already use GNU Make as their default, but for
+those using a BSD Make:
+* "gmake (GNU Make)":
Each package may have requirements of its own, of course.
@@ -35,6 +37,7 @@ for rubinius development.
=== Requirements through RubyGems
* rake
+* ParseTree
Rake may be obtained with the `gem install` command. See `gem help` and for more information.
@@ -48,40 +51,47 @@ for more information.
* "libexecinfo (backtrace utilities)":
+==== Debian/Ubuntu family systems
+For the build to succeed you will need these packages:
+* ruby-dev
+* libreadline5-dev
+* zlib1g-dev
== Rubinius itself
You need to check Rubinius out through Git (which we just installed). The
invocation looks like this:
- git clone rubinius
+ git clone git://
-For more information on rubinius' best practices for git, see "using
+For more information on Rubinius' best practices for git, see "using
== Compiling Rubinius
-Once you have all the prerequisites installed, building rubinius is as simple
+The C++ VM is compiled using Rake. Typically, it will be as simple as:
- cd /path/to/rubinius
rake build
-This will give you a binary, @./shotgun/rubinius@ which can then be invoked to
-run scripts. If your system compiler is not GCC 4.x, you can set the CC environment variable:
- CC=/path/to/gcc rake build
+== Installing Rubinius
-If you want a development version (no optimisations, extra debug info), set the DEV environment variable:
+The C++ should not currently be installed separately.
- DEV=1 rake build
+== Running Rubinius
-== Installing Rubinius
+Once compiled, you can verify the VM works:
+ bin/rbx -v
-To install @rbx@ as a shortcut for @./shotgun/rubinius@:
+Rubinius generally works like Ruby from the command-line. For example:
- rake install
+ bin/rbx -e 'puts "Hello!"'
== Troubleshooting and platform-specific notes
@@ -91,31 +101,3 @@ irc:// The forums here are an alternative method though the
response is probably not going to be as swift. We will try to collect tips
here, too.
-=== 64-bit platforms
-Currently mostly works on amd64 and Opteron. Other 64-bit platforms have not
-been tested.
-=== Mac OS X with Fink
-If you are getting an error like this one:
- glibtool: link: cannot build libtool library `' from non-libtool objects: ...
-This is probably because you are using an old glibtool (1.3.5 or similar) that
-came with Fink. This is the case when `which glibtool` returns
-/sw/bin/glibtool. You want to use /usr/bin/glibtool (1.5) instead. If you are
-radical you can just `sudo rm /sw/bin/glibtool` to fix this mess.
-=== Ubuntu
-For the build to succeed you will need these packages:
-* libglib2.0-dev
-* zlib1g-dev

0 comments on commit 0e13a42

Please sign in to comment.