From: Luigi Pinca <luigipinca@gmail.com>
Date: Sun, 24 Feb 2013 13:39:13 +0000 (+0100)
Subject: updated README with installation instructions
X-Git-Url: https://git.saalbach.dev/?a=commitdiff_plain;h=6b7d6da8e5ca8f9368ca49253883c42747b171fb;p=binbsis50.git

updated README with installation instructions
---

diff --git a/README.md b/README.md
index dc63a82..5d40e89 100644
--- a/README.md
+++ b/README.md
@@ -2,23 +2,43 @@
 
 binb is a simple, realtime, multiplayer, competitive music listening game.
 
-To play the game: [http://binb.nodejitsu.com](http://binb.nodejitsu.com) 
+To play the game: [http://binb.nodejitsu.com](http://binb.nodejitsu.com)
 
-## Browser compatibiliy ##
+## Installation
+
+Unless previously installed you'll need the following packages:
+
+- [Node.js](http://nodejs.org/)
+- [Redis](http://redis.io/)
+- [Cairo](http://cairographics.org/)
+
+Please use their sites to get detailed installation instructions.
+
+### Install binb
+
+Once you have redis server up and running type:
+    
+    $ make install
+
+Then run `$ npm start` or `$ node app.js` to start the app.
+
+Point your browser to `http://127.0.0.1:8138` and have fun!
+
+## Browser compatibiliy
 
 Ideal setup is a browser with websocket support and able to decode .m4a format natively. 
 
-For this reason binb is optimized for Google Chrome but also works in all major browsers (if version is recently enough).
+For this reason binb is optimized for Google Chrome but also works in all major browsers.
 
-## Shout-Outs ##
+## Shout-Outs
 
-* Thanks to [beatquest.fm](http://beatquest.fm) for inspiration!
-* Thanks to [nodejitsu](http://nodejitsu.com/) for application hosting.
+- Thanks to [beatquest.fm](http://beatquest.fm) for inspiration.
+- Thanks to [nodejitsu](http://nodejitsu.com/) for application hosting.
 
-## Bug tracker ##
+## Bug tracker
 
 Have a bug? Please create an [issue](https://github.com/lpinca/binb/issues) here on GitHub, with a description of the problem, browser and operating system information and how to reproduce the problem.
 
-## Copyright and license ##
+## Copyright and license
 
 binb is released under the MIT license. See LICENSE for details.