]> git.example.dev Git - binbsis50.git/commitdiff
updated installation instructions with a possible errors section
authorTim Siebels@Ubuntu <tim_siebels_aurich@yahoo.de>
Sun, 25 May 2014 18:35:26 +0000 (20:35 +0200)
committerLuigi Pinca <luigipinca@gmail.com>
Sun, 25 May 2014 20:08:37 +0000 (22:08 +0200)
README.md

index b585595c4ac8e8193839139d1a005df7847a5918..49d2db5e2999524ec45a3a71e354c5a92e9ea890 100644 (file)
--- a/README.md
+++ b/README.md
@@ -16,23 +16,45 @@ Please use their sites to get detailed installation instructions.
 
 You also need `UglifyJS` installed globally:
 
-    $ npm install uglify-js -g
+```shell
+npm install uglify-js -g
+```
 
 ### Install binb
 
 Once you have redis server up and running type:
 
-    $ make install
+```shell
+make install
+```
 
-Then run `$ npm start` or `$ node app.js` to start the app.
+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!
 
+#### Possible errors
+
+Some package managers name the Node.js binary `nodejs`. In this case you'll get
+the following error:
+
+```shell
+/usr/bin/env: node: No such file or directory
+```
+
+To make it work you can create a symbolic link:
+
+```shell
+sudo ln -s /usr/bin/nodejs /usr/bin/node
+```
+
+and run `make install` again.
+
 ## Browser compatibiliy
 
 binb requires a browser that supports the WebSocket protocol.
 
-Refer to this [table](http://caniuse.com/websockets) for details on compatibility.
+Refer to this [table](http://caniuse.com/websockets) for details on
+compatibility.
 
 ## Shout-Outs
 
@@ -41,7 +63,9 @@ Refer to this [table](http://caniuse.com/websockets) for details on compatibilit
 
 ## Bug tracker
 
-Have a bug? Please create an [issue](https://github.com/lpinca/binb/issues) here on GitHub, with a description of the problem, how to reproduce it and in what browser it occurred.
+Have a bug? Please create an [issue](https://github.com/lpinca/binb/issues)
+here on GitHub, with a description of the problem, how to reproduce it and in
+what browser it occurred.
 
 ## Copyright and license