From 55a8bf8c9b350c83a007158022b20be0e15ee908 Mon Sep 17 00:00:00 2001 From: Jochen Klein Date: Wed, 26 Oct 2016 20:38:43 +0200 Subject: [PATCH] Update readme * Improves the readme by adding `Get Started` section to get html-battle running. --- README.md | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5dfbed6..8596970 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,30 @@ # html battle -We wrote this tool for a event at [Toolbox Bodensee](http://toolbox-bodensee.de/) +We wrote this tool for an event at [Toolbox Bodensee](http://toolbox-bodensee.de/). + +## Get Started +html-battle is based on [Node.js](https://nodejs.org/) and uses [npm](https://www.npmjs.com/). Make sure you have installed it. + +Once you have cloned `html-battle`, install the packages by running + +```bash +$ cd html-battle +$ npm install +``` + +You will notice a new directory `node_modules` containing the installed packages. Next, you may have to install the dependencies using [Bower](https://bower.io/) (which has been installed in the previous step). Therefore, run + +```bash +$ cd public +$ bower install +``` + +Finally, +```bash +# Start the server, e.g. node server.js -p 8888 -h localhost +$ node server.js [-p , default: 8080] [-h , default: 192.168.178.55] +``` +will start the server on the given `port` and `hostname`. ## Features @@ -13,3 +37,4 @@ We wrote this tool for a event at [Toolbox Bodensee](http://toolbox-bodensee.de/ * [Thomas Kekeisen](https://github.com/blaues0cke) * [Michael Malura](https://github.com/maluramichael) +* [Jochen Klein](https://github.com/jochenklein)