Skip to content
Browse files

Updated README.md; gem instructions, requirements.

  • Loading branch information...
1 parent a984866 commit 2a10ee91ae10d72c907dec9357bad8aa87c9fdb1 @pda committed Jan 18, 2012
Showing with 41 additions and 13 deletions.
  1. +41 −13 README.md
View
54 README.md
@@ -3,15 +3,52 @@ ROFLBALT
A Canabalt-inspired sidescroller in ASCII (with ANSI color!) for your console.
-Run it in Terminal.app or iTerm.app with xterm-256color.
+
+WTF?
+----
+
+It's built by [Paul Annesley][1] ([@pda][2])
+and [Dennis Hotson][3] ([@dennishotson][4])
+with < 500 lines of Ruby, no dependencies;
+it just uses `print` and raw xterm-256color escape codes.
+
+[1]: http://paul.annesley.cc/
+[2]: https://twitter.com/pda
+[3]: http://dhotson.tumblr.com/
+[4]: https://twitter.com/dennishotson
+
+
+Requirements
+------------
+
+**Ruby 1.9**. It doesn't work with Ruby 1.8, but I'm sure somebody could easily fix that...
+
+You'll need a terminal with 256 color support and at least 120 columns by 40 rows of text.
+
+* For Mac OS X we highly recommend [iTerm2](http://www.iterm2.com/),
+but if you're running Lion (or newer?) you can use the default Terminal.app.
+* For Windows, I imagine [PuTTY](http://www.chiark.greenend.org.uk/~sgtatham/putty/)
+is still the thing to use.
+* For GNU/Linux etc, use xterm!
+
Instructions
------------
-With Ruby 1.9 installed, run:
+```shell
+ # install:
+ gem install roflbalt
+
+ # using rbenv? it rocks.
+ rbenv rehash
+
+ # LOL
+ roflbalt
+```
+
+Press any key to jump! If you can't find the any key, try the spacebar.
- cd roflbalt
- ./bin/roflbalt
+And of course, ctrl-c to exit.
"Screenshot"
@@ -38,15 +75,6 @@ With Ruby 1.9 installed, run:
::::::::::::::::::::: ::: :: :: :: ::
:: :: :: ::: :: :: :: ::
-WTF?
-----
-
-This was made by [Dennis Hotson][1] and [Paul Annesley][2] at [Rails Camp X][3] in Adelaide.
-
-[1]: http://dhotson.tumblr.com/
-[2]: http://paul.annesley.cc/
-[3]: http://railscamps.com/
-
License
-------

0 comments on commit 2a10ee9

Please sign in to comment.
Something went wrong with that request. Please try again.