From: Luigi Pinca Date: Sun, 17 May 2015 20:13:10 +0000 (+0200) Subject: updated installation instructions X-Git-Url: https://git.saalbach.dev/?a=commitdiff_plain;h=84d05ad0251093fde094b1cf3ddfe94cbe46b3c9;p=binbsis50.git updated installation instructions --- diff --git a/README.md b/README.md index f066717..48b937a 100644 --- a/README.md +++ b/README.md @@ -14,21 +14,27 @@ Unless previously installed you'll need the following packages: Please use their sites to get detailed installation instructions. -You also need `UglifyJS` installed globally: +### Install binb + +The first step is to install the dependencies: ```shell -npm install uglify-js -g +npm install ``` -### Install binb +Then you need to minify the assets: + +```shell +npm run minify +``` -Once you have redis server up and running type: +Now make sure that the Redis server is running and load some sample tracks: ```shell -make install +npm run import-data ``` -Then run `npm start` or `node app.js` to start the app. +Finally run `npm start` or `node app.js` to start the app. Point your browser to `http://127.0.0.1:8138` and have fun! @@ -38,16 +44,16 @@ 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 +sh: node: command not found ``` -To make it work you can create a symbolic link: +To fix this issue, you can create a symbolic link: ```shell sudo ln -s /usr/bin/nodejs /usr/bin/node ``` -and run `make install` again. +and try again. ## Browser compatibiliy @@ -56,9 +62,9 @@ binb requires a browser that supports the WebSocket protocol. Refer to this [table](http://caniuse.com/websockets) for details on compatibility. -## Shout-Outs +## Shout out to -- Thanks to [beatquest.fm](http://beatquest.fm) for inspiration. +- [beatquest.fm](http://beatquest.fm) for inspiration. ## Bug tracker @@ -68,4 +74,4 @@ what browser it occurred. ## Copyright and license -binb is released under the MIT license. See LICENSE for details. +binb is released under the MIT license. See [LICENSE](LICENSE) for details.