Permalink
Browse files

README update, with prerequisites for Linux

  • Loading branch information...
1 parent f841059 commit 963613ed3114712ffbc92f2067e4523d23403a67 @jhs committed Mar 15, 2010
Showing with 34 additions and 5 deletions.
  1. +34 −5 README.markdown
View
@@ -7,16 +7,45 @@ Using Ruby in a development team poses several common problems:
2. Different machines have different software versions
3. People make undocumented changes to development or production servers
-All of these things reduce the ability to launch a fresh deployment of the software for development, staging, or production.
+All of these things reduce the ability to launch a fresh deployment of the
+software for development, staging, or production.
Ruby in a Box is a very simple build system to solve these problems:
-1. Depend only on very fundamental packages (gcc, Bash, etc.) which can be relied upon (**no chicken/egg problems**).
+1. Depend only on very fundamental packages (gcc, Bash, etc.) which can be
+ relied upon (**no chicken/egg problems**).
2. Build everything else from the source checkout: Ruby, gems, etc.
-3. Everything runs from inside the checkout. To un-install, just delete all the files.
+3. Everything runs from inside the checkout. To un-install, just delete all
+ the files.
Usage
-----
-Ruby in a Box is meant to be a Git submodule of other projects. Developers can hook into the build process to add
-their own gems, configuration files, etc.
+Ruby in a Box is meant to be a Git submodule of other projects. Developers
+can hook into the build process to add their own gems, configuration files,
+etc.
+
+To use it, source the `env.sh` file. Whatever isn't built yet will be, and
+whatever is already built will be used.
+
+ $ . ruby-inabox/env.sh
+ # ... Dependencies built
+
+ $ which ruby
+ ruby-inabox/build/bin/ruby
+
+ $ which gem
+ ruby-inabox/build/bin/gem
+
+ $ gem list
+ rake
+
+Requirements
+------------
+
+Ruby in a Box depends on a few fundamental software packages which either
+ship with the operating system or can be installed trivially.
+
+On **Ubuntu**, and **Debian**, run the following command:
+
+ apt-get -y install make gcc zlib1g-dev libssl-dev libreadline5-dev

0 comments on commit 963613e

Please sign in to comment.