From cff3dcdc873c8a7d288c1e7abc5111c176b6f7ce Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ga=C3=ABl=20M=C3=A9tais?= <gael.metais@gmail.com>
Date: Thu, 14 Aug 2014 17:07:44 +0200
Subject: [PATCH] Installation instructions in README

---
 README.md                       | 58 +++++++++++++++++++++++++++++++--
 server_config/server_install.sh | 10 +++---
 2 files changed, 60 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index dfdd663..436f0fa 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,58 @@
-YellowLabTools
-==============
+# Yellow Lab Tools
 
 Online tool designed to help Front-End developers optimize their website
 
-[![Dependency Status](https://gemnasium.com/gmetais/YellowLabTools.svg)](https://gemnasium.com/gmetais/YellowLabTools)
\ No newline at end of file
+[![Dependency Status](https://gemnasium.com/gmetais/YellowLabTools.svg)](https://gemnasium.com/gmetais/YellowLabTools)
+
+
+## How it works
+
+The tool is based on the fabulous [Phantomas](https://github.com/macbre/phantomas) by Maciej Brencz, that loads a page and collects many web performance metrics.
+I rewrote some modules to deeper analyse Javascript interactions with the DOM (especially with jQuery).
+And then it is wrapped inside a small server (inspired by my favorite tool: [WebPageTest](http://www.webpagetest.org/)).
+
+**There are so many things left to do, your help would be greatly appreciated! Please report bugs, ask for evolutions and come code with me.**
+
+
+## Install your own instance
+
+### Manual installation
+
+You need this 3 brothers: [Git](http://git-scm.com/downloads), [NodeJS](http://nodejs.org/download/) and [Bower](http://bower.io/#install-bower). Click on the links to know how to install them.
+
+1) Clone this repository somewhere on your computer:
+```shell
+git clone https://github.com/gmetais/YellowLabTools.git
+```
+
+2) Get inside the newly created folder and install the dependencies:
+```shell
+cd YellowLabTools
+npm install
+bower install
+```
+
+3) Launch the server
+```shell
+node server.js
+```
+
+4) Open you browser to [http://localhost:8383](http://localhost:8383). The default port 8383 can be changed in `server_config/settings.json`.
+
+
+### In a virtual machine with Vagrant
+
+You need VirtualBox & Vagrant.
+
+1) Clone this repository somewhere on your computer:
+```shell
+git clone https://github.com/gmetais/YellowLabTools.git
+```
+
+2) Get inside the newly created folder and build the virtual machine:
+```shell
+cd YellowLabTools
+vagrant up
+```
+
+3) Open your browser to [http://10.10.10.10](http://10.10.10.10).
diff --git a/server_config/server_install.sh b/server_config/server_install.sh
index 9a16300..f3843e6 100644
--- a/server_config/server_install.sh
+++ b/server_config/server_install.sh
@@ -3,13 +3,13 @@
 # APT-GET
 sudo apt-get update
 sudo apt-get install lsb-release -y --force-yes
-sudo apt-get install curl git -y --force-yes
+sudo apt-get install curl git python-software-properties -y --force-yes
 
 # Installation of NodeJS
-curl https://raw.githubusercontent.com/creationix/nvm/v0.12.2/install.sh | bash
+sudo add-apt-repository -y ppa:chris-lea/node.js
+sudo apt-get update
+sudo apt-get install -y nodejs
 source ~/.profile
-nvm install v0.10.30
-nvm use v0.10.30
 
 # Installation of some packages globally
 npm install bower -g
@@ -22,7 +22,7 @@ cd /space
 git clone https://github.com/gmetais/YellowLabTools.git --branch master
 cd YellowLabTools
 npm install
-bower install --config.interactive=false
+bower install --config.interactive=false --allow-root
 
 # Start the server
 rm server_config/settings.json