diff --git a/artifact_documentation/INSTALL.md b/artifact_documentation/INSTALL.md index bd8c3b9..d2b5bde 100644 --- a/artifact_documentation/INSTALL.md +++ b/artifact_documentation/INSTALL.md @@ -2,22 +2,31 @@ ## Getting the virtual machine -The Causal Testing virtual machine file is located here: [CausalTesting_Artifact.ova](https://drive.google.com/open?id=1KHwFB2S9-pdzdgChGxqG1AnQNqa9glPj) +1. Download [VirtualBox](https://www.virtualbox.org). +2. Download virtual machine file [CausalTesting_Artifact.ova](https://drive.google.com/open?id=1hyzHYCQEkOzYiLGldkBVxNvQt0Phb-th). +
**Please note this is a large file (5BG) and may take some time to download.** +3. Open VirtualBox. +4. Go to **File > Import Appliance...** +5. Find and select the downloaded virtual machine file (CausalTesting_Artifact.ova). Click **"Continue"**. +6. Leave all the settings as they are and click **"Import"**. -Download this file to your computer. Make sure you make note of where you put the file, as you will need it in the next step. +Once the virtual machine is imported, it will appear in your VirtualBox Manager as **CausalTesting_Artifact**. -## Loading the virtual machine +You can now start the virtual machine by clicking the green **"Start"** arrow at the top of the VirtualBox Manager (see screenshot below). -Before you can run the virtual machine, you will need to download and install [VirtualBox 6](https://www.virtualbox.org). +VirtualBox Manager -Once you've installed VirtualBox, you're ready to load and run the virtual machine. -To load the virtual machine, you will need to import the **CausalTesting_Artifact.ova** file into VirtualBox. You do so as follows: +### Resizing the virtual machine screen -1. Open VirtualBox. -2. Go to **File > Import Appliance...** -3. Find and select the downloaded virtual machine file (CausalTesting_Artifact.ova). Click **"Continue"**. -4. Leave all the settings as they are and clikc **"Import"**. +If the virtual machine loads and you find it is not an appropriate size, you can find the size that works for you by doing the following: -Once the virtual machine is imported, it will appear in your VirtualBox Manager as **CausalTesting_Artifact**. You can now start the virtual machine by clicking the green **"Start"** arrow at the top of the VirtualBox Manager (see screenshot below). +1. In your VirtualBox VM menu, go to **View > Virtual Screen 1 > ...**. You will see different scaling options; select the one that best suites your screen. + +Resize menu + +2. Your menu may look different if you are running a different operating system. However, if given percentages to re-scale they will have the same effect. + +### Waking up the virtual machine + +If you leave the virtual machine and return to a black screen or screen saver, press any key on your keyboard to wake up the virtual machine. -VirtualBox Manager