From e183f44d145ed0c3780d3eb845a61bec1b53dfaf Mon Sep 17 00:00:00 2001
From: Shay Nehmad <shay.nehmad@guardicore.com>
Date: Tue, 4 Feb 2020 15:08:59 +0200
Subject: [PATCH] Improved deployment_scripts/README.md

Fix linter errors and improve English + security recommendations.
---
 deployment_scripts/README.md | 67 ++++++++++++++++++++++--------------
 1 file changed, 42 insertions(+), 25 deletions(-)

diff --git a/deployment_scripts/README.md b/deployment_scripts/README.md
index 812337eba..fa8c898f1 100644
--- a/deployment_scripts/README.md
+++ b/deployment_scripts/README.md
@@ -1,32 +1,49 @@
-# Files used to deploy development version of infection monkey
-## Windows
+# Deployment guide for a development environemnt
 
-Before running the script you must have git installed.<br>
-`Invoke-WebRequest https://raw.githubusercontent.com/guardicore/monkey/develop/deployment_scripts/deploy_windows.ps1 -OutFile deploy_windows.ps1`
+This guide is for you if you wish to develop for Infection Monkey. If you only want to use it, please download the relevant version from [our website](https://infectionmonkey.com).
 
-Then execute the resulting script with your shell. 
-First argument is an empty directory (script can create one) and second is branch you want to clone.
+## Prerequisites
 
-Example usages:<br>
-`.\deploy_windows.ps1` (Sets up monkey in current directory under .\infection_monkey)<br>
-`.\deploy_windows.ps1 -monkey_home "C:\test"` (Sets up monkey in C:\test)<br>
-`.\deploy_windows.ps1 -branch "master"` (Sets up master branch instead of develop in current dir)
+Before running the script you must have `git` installed. If you don't have `git` installed, please follow [this guide](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).
 
-If you run into Execution Policy warnings, you can disable them by prefixing the following snippet
-`powershell -ExecutionPolicy ByPass -Command "[original command here]"`
+## Deploy on Windows
 
-Don't forget to add python to PATH or do so while installing it via this script.<br>
+Run the following command in powershell:
 
-## Linux
+```powershell
+Invoke-WebRequest https://raw.githubusercontent.com/guardicore/monkey/develop/deployment_scripts/deploy_windows.ps1 -OutFile deploy_windows.ps1
+```
 
-Linux deployment script is meant for Ubuntu 16.x machines.
-You must have root permissions, but don't run the script as root.<br>
-`wget https://raw.githubusercontent.com/guardicore/monkey/develop/deployment_scripts/deploy_linux.sh`
-Then execute the resulting script with your shell. 
-First argument should be an absolute path of an empty directory (script will create one if doesn't exist, default is ./infection_monkey).
-Second parameter is the branch you want to clone (develop by default).
-Example usages:<br>
-`./deploy_linux.sh` (deploys under ./infection_monkey)<br>
-`./deploy_linux.sh "/home/test/monkey"` (deploys under /home/test/monkey)<br>
-`./deploy_linux.sh "" "master"` (deploys master branch in script directory)<br>
-`./deploy_linux.sh "/home/user/new" "master"` (if directory "new" is not found creates it and clones master branch into it)<br>
+This will download our deploy script. It's a good idea to read it quickly before executing it!
+
+After downloading that script, execute it in a shell (like `cmd` or `powershell`). The first argument is an empty directory (script can create one). The second argument is which branch you want to clone - by default, the script will check out the `develop` branch. Some example usages:
+
+- `.\deploy_windows.ps1` (Sets up monkey in current directory under .\infection_monkey)
+- `.\deploy_windows.ps1 -monkey_home "C:\test"` (Sets up monkey in C:\test)
+- `.\deploy_windows.ps1 -branch "master"` (Sets up master branch instead of develop in current dir)
+
+### Troubleshooting
+
+- If you run into Execution Policy warnings, you can disable them by prefixing the following snippet: `powershell -ExecutionPolicy ByPass -Command "[original command here]"`
+- Don't forget to add python to PATH or do so while installing it via this script.
+
+## Deploy on Linux
+
+Linux deployment script is meant for Ubuntu 16 and Ubuntu 18 machines.
+
+Your user must have root permissions; however, don't run the script as root!
+
+```sh
+wget https://raw.githubusercontent.com/guardicore/monkey/develop/deployment_scripts/deploy_linux.sh
+```
+
+This will download our deploy script. It's a good idea to read it quickly before executing it!
+
+Then execute the resulting script with your shell.
+
+After downloading that script, execute it in a shell. The first argument should be an absolute path of an empty directory (the script will create one if doesn't exist, default is ./infection_monkey). The second parameter is the branch you want to clone (develop by default). Some example usages:
+
+- `./deploy_linux.sh` (deploys under ./infection_monkey)
+- `./deploy_linux.sh "/home/test/monkey"` (deploys under /home/test/monkey)
+- `./deploy_linux.sh "" "master"` (deploys master branch in script directory)
+- `./deploy_linux.sh "/home/user/new" "master"` (if directory "new" is not found creates it and clones master branch into it)