Added installation scripts and updated README

Author: Jake Mathews

Diff for: README.md

@@ -1,42 +1,63 @@
 # FaceShift
 An electron app that uses facial tracking to move your mouse cursor.
 
-## Pre-requisites 
+## Pre-requisites
+Prerequisites can be installed via the install script in this repository which is the recommended way for installing FaceShift.
+This script will only help installation on mac. Windows will require manual installation of these tools.
+If you have not yet cloned the repository, download just the 'install-faceshift-clone.sh' file. Place it where you want to install faceshift on your system. Now run the following command:
+
+```
+bash ./install-faceshift-clone.sh
+```
+
+If you have already cloned the repository, run the following command:
+
+```
+bash ./install-faceshift.sh
+```
+
+Note: The script only set the SnowBoy environment variable temporarily. If you terminate the terminal session, it will no longer be set. Setting it permanently will be dependent on your operating system and your preferred way of setting it. The API key for snowboy can be found in the install script.
+
+If you do not want to run the script or are on Windows, you will need to install the following components manually.
+
+* Git
 
 * Node
 
 * [Yarn](https://yarnpkg.com/lang/en/docs/install/ )
 
-* Electron 
+* Electron
 ```
 $ yarn global add electron
 ```
 
-## Run the project
-1. Clone the project
-```
-$ git clone https://github.com/FaceShift/faceshift.git
-```
-2. Build the project
-```
-$ cd faceshift
-$ yarn
-$ yarn watch
-```
+* SoX
+Install SoX for voice commands [http://sox.sourceforge.net/](http://sox.sourceforge.net/)
 
-3. Install SoX for voice commands [http://sox.sourceforge.net/](http://sox.sourceforge.net/)
+* Python 2.7.x
 
-4. Get an Api key from Snowboy 
+* Get an Api key from Snowboy
 API token can be obtained by logging into [https://snowboy.kitt.ai](https://snowboy.kitt.ai), click on 'Profile settings'
 
-5. Create an environtment variable
+* Create an environment variable. This process differs for Windows and Mac
 ```
 SNOWBOY_API = [your api key]
 ```
 
-6. Run the project (open a different terminal/command window)
+## Run the project
+1. Build the project
+
+```
+$ cd faceshift
+$ yarn
+$ yarn watch
+```
+
+2. Run the project (open a different terminal/command window)
 
 ```
 Mac $ yarn start-mac
 Windows $ yarn start-win
 ```
+
+

Diff for: install-faceshift-clone.sh

@@ -0,0 +1,37 @@
+#!/bin/sh
+
+echo "[FACESHIFT] Installing faceshift pre-requisites"
+
+echo "[FACESHIFT] Installing homebrew"
+/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
+
+echo "[FACESHIFT] Installing git"
+brew install git
+
+echo "[FACESHIFT] Installing python"
+brew install python2
+
+echo "[FACESHIFT] Installing npm"
+brew install npm
+
+echo "[FACESHIFT] Installing yarn"
+brew install yarn
+
+echo "[FACESHIFT] Installing electron"
+yarn global add electron
+
+echo "[FACESHIFT] Installing sox"
+brew install sox
+
+echo "[FACESHIFT] Cloning faceshift from GitHub"
+git clone https://github.com/FaceShift/faceshift.git
+cd ./faceshift
+
+echo "[FACESHIFT] Setting environment variables"
+export SNOWBOY_API=27cacc0c071c70c76b61af43b514ec2453a3584a
+
+echo "[FACESHIFT] Installing npm dependencies with yarn"
+yarn
+
+echo "[FACESHIFT] FaceShift installed! Run the command 'yarn watch' in terminal with the workign directory set to the installing folder of faceshift"
+echo "[FACESHIFT] In another terminal window, navigate to the faceshift installation directory and run the command 'yarn start-mac'"

Diff for: install-faceshift.sh

@@ -0,0 +1,30 @@
+#!/bin/sh
+
+echo "[FACESHIFT] Installing faceshift pre-requisites"
+
+echo "[FACESHIFT] Installing homebrew"
+/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
+
+echo "[FACESHIFT] Installing python"
+brew install python2
+
+echo "[FACESHIFT] Installing npm"
+brew install npm
+
+echo "[FACESHIFT] Installing yarn"
+brew install yarn
+
+echo "[FACESHIFT] Installing electron"
+yarn global add electron
+
+echo "[FACESHIFT] Installing sox"
+brew install sox
+
+echo "[FACESHIFT] Setting environment variables"
+export SNOWBOY_API=27cacc0c071c70c76b61af43b514ec2453a3584a
+
+echo "[FACESHIFT] Installing npm dependencies with yarn"
+yarn
+
+echo "[FACESHIFT] FaceShift installed! Run the command 'yarn watch' in terminal with the workign directory set to the installing folder of faceshift"
+echo "[FACESHIFT] In another terminal window, navigate to the faceshift installation directory and run the command 'yarn start-mac'"