From 0609bc2063d488cf16f3baa326c39ec0bde6c73a Mon Sep 17 00:00:00 2001
From: Mike Salvatore <mike.s.salvatore@gmail.com>
Date: Tue, 27 Jul 2021 15:31:33 -0400
Subject: [PATCH] Build: Add README.md for build_package.sh

---
 build_scripts/README.md          | 45 ++++++++++++++++++++++++++++++++
 build_scripts/appimage/README.md | 27 -------------------
 build_scripts/docker/README.md   | 20 --------------
 3 files changed, 45 insertions(+), 47 deletions(-)
 create mode 100644 build_scripts/README.md
 delete mode 100644 build_scripts/appimage/README.md
 delete mode 100644 build_scripts/docker/README.md

diff --git a/build_scripts/README.md b/build_scripts/README.md
new file mode 100644
index 000000000..60e5b68d6
--- /dev/null
+++ b/build_scripts/README.md
@@ -0,0 +1,45 @@
+# Infection Monkey Linux Package Builder
+
+## About
+
+This directory contains the necessary artifacts for building an Infection
+Monkey packages for Linux.
+
+## AppImage
+
+### Building an AppImage
+
+1. Create a clean VM or LXC (not docker!) based on Ubuntu 18.04.
+1. Copy the `build_scipts/` directory to `$HOME/` in the VM.
+1. On the VM, `cd $HOME/build_scripts`
+1. Run `sudo -v`.
+1. Execute `./build_package.sh --package appimage`. This will pull all necessary dependencies
+   and build the AppImage.
+
+NOTE: This script is intended to be run from a clean VM. You can also manually
+remove build artifacts by running `appimage/clean.sh`
+
+### Running the AppImage
+
+The build script will produce an AppImage executable named
+`Infection_Monkey-x86_64.AppImage`. Simply execute this file and you're off to
+the races.
+
+A new directory, `$HOME/.monkey_island` will be created to store runtime
+artifacts.
+
+## Docker
+
+### Building a Docker image
+1. Create a clean Ubuntu 18.04 VM (not WSL).
+1. Copy the `build_scipts/` directory to `$HOME/` in the VM.
+1. On the VM, `cd $HOME/build_scripts`
+1. Run `sudo -v`.
+1. Execute `./build_package.sh --package docker`. This will pull all necessary dependencies
+   and build the Docker image.
+
+NOTE: This script is intended to be run from a clean VM. You can also manually
+remove build artifacts by running `docker/clean.sh`
+
+### Running the Docker Image
+See `docker/DOCKER_README.md` for instructions on running the docker image.
diff --git a/build_scripts/appimage/README.md b/build_scripts/appimage/README.md
deleted file mode 100644
index bbf6a61e8..000000000
--- a/build_scripts/appimage/README.md
+++ /dev/null
@@ -1,27 +0,0 @@
-# Monkey Island AppImage
-
-## About
-
-This directory contains the necessary artifacts for building an Infection
-Monkey AppImage
-
-## Building an AppImage
-
-1. Create a clean VM or LXC (not docker!) based on Ubuntu 18.04.
-1. Copy the `deployment_scripts/appimage` directory to `$HOME/` in the VM.
-1. On the VM, `cd $HOME/appimage`
-1. Run `sudo -v`.
-1. Execute `./build_appimage.sh`. This will pull all necessary dependencies
-   and build the AppImage.
-
-NOTE: This script is intended to be run from a clean VM. You can also manually
-remove build artifacts by running `appimage/clean.sh`
-
-## Running the AppImage
-
-The build script will produce an AppImage executable named
-`Infection_Monkey-x86_64.AppImage`. Simply execute this file and you're off to
-the races.
-
-A new directory, `$HOME/.monkey_island` will be created to store runtime
-artifacts.
diff --git a/build_scripts/docker/README.md b/build_scripts/docker/README.md
deleted file mode 100644
index d01890b23..000000000
--- a/build_scripts/docker/README.md
+++ /dev/null
@@ -1,20 +0,0 @@
-# Monkey Island Docker Image
-
-## About
-
-This directory contains the necessary artifacts for building an Infection
-Monkey Docker image.
-
-## Building a Docker image
-1. Create a clean Ubuntu 18.04 VM (not WSL).
-1. Copy the `docker/` directory to `$HOME/` in the VM.
-1. On the VM, `cd $HOME/docker`
-1. Run `sudo -v`.
-1. Execute `./build_docker.sh`. This will pull all necessary dependencies
-   and build the Docker image.
-
-NOTE: This script is intended to be run from a clean VM. You can also manually
-remove build rtifacts by running `docker/clean.sh`
-
-## Running the Docker Image
-See `docker/DOCKER_README.md` for instructions on running the docker image.