From f9118c3e9650d70776bdbf5ac1be079544348a8a Mon Sep 17 00:00:00 2001 From: "Tim Siebels@Ubuntu" Date: Sun, 25 May 2014 20:35:26 +0200 Subject: [PATCH] updated installation instructions with a possible errors section --- README.md | 34 +++++++++++++++++++++++++++++----- 1 file changed, 29 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index b585595..49d2db5 100644 --- 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 -- 2.54.0