Merge pull request #2 from Autonomous-Resilient-Cyber-Defence/dev

v2.0.0 Added additional install instructions to the README.md

README.md

@@ -1,26 +1,72 @@
 # PrimAITE
 
+PrimAITE (Primary-level AI Training Environment) is a simulation environment for training AI under the ARCD programme.
+
 ## Getting Started with PrimAITE
 
-
+### 💫 Install & Run
-### Pre-Requisites
-
-In order to get **PrimAITE** installed, you will need to have the following installed:
-
-- `python3.8+`
-- `python3-pip`
-- `virtualenv`
-
 **PrimAITE** is designed to be OS-agnostic, and thus should work on most variations/distros of Linux, Windows, and MacOS.
+Currently, the PRimAITE wheel can only be installed from GitHub. This may change in the future with release to PyPi.
 
-### Installation from source (Developer Install)
+#### Windows (PowerShell)
-#### 1. Create a new python virtual environment (venv)
+
+**Prerequisites:**
+* Manual install of Python >= 3.8 < 3.11
+
+**Install:**
+
+``` powershell
+mkdir ~\primaite
+cd ~\primaite
+python3 -m venv .venv
+attrib +h .venv /s /d # Hides the .venv directory
+.\.venv\Scripts\activate
+pip install https://github.com/Autonomous-Resilient-Cyber-Defence/PrimAITE/releases/download/v2.0.0/primaite-2.0.0-py3-none-any.whl
+primaite setup
+```
+
+#### Unix
+
+**Prerequisites:**
+* Manual install of Python >= 3.8 < 3.11
+
+``` bash
+sudo add-apt-repository ppa:deadsnakes/ppa
+sudo apt install python3.10
+sudo apt-get install python3-pip
+sudo apt-get install python3-venv
+```
+**Install:**
+
+``` bash
+mkdir ~/primaite
+cd ~/primaite
+python3 -m venv .venv
+source .venv/bin/activate
+pip install https://github.com/Autonomous-Resilient-Cyber-Defence/PrimAITE/releases/download/v2.0.0/primaite-2.0.0-py3-none-any.whl
+primaite setup
+```
+
+
+### Developer Install from Source
+To make your own changes to PrimAITE, perform the install from source (developer install)
+
+#### 1. Clone the PrimAITE repository
+``` unix
+git clone git@github.com:Autonomous-Resilient-Cyber-Defence/PrimAITE.git
+```
+
+#### 2. CD into the repo directory
+``` unix
+cd PrimAITE
+```
+#### 3. Create a new python virtual environment (venv)
 
 ```unix
 python3 -m venv venv
 ```
 
-#### 2. Activate the venv
+#### 4. Activate the venv
 
 ##### Unix
 ```bash
@@ -32,19 +78,19 @@ source venv/bin/activate
 .\venv\Scripts\activate
 ```
 
-#### 3. Install `primaite` with the dev extra into the venv along with all of it's dependencies
+#### 5. Install `primaite` with the dev extra into the venv along with all of it's dependencies
 
 ```bash
 python3 -m pip install -e .[dev]
 ```
 
-#### 4. Perform the PrimAITE setup:
+#### 6. Perform the PrimAITE setup:
 
 ```bash
 primaite setup
 ```
 
-## Building documentation
+## 📚 Building documentation
 The PrimAITE documentation can be built with the following commands:
 
 ##### Unix