prereqs.md

# Pre-requisites

Allthough it is theoretically possible to get ROS, Webots and the Coventry FSAI code working correctly in Windows no one has yet done so. If you do manage it, you can write the documentation for how you did it.

As the Coventry FSAI car is running Linux (Ubuntu) that is the recommended method for developing for the car.

It is important that you use the correct versions of the software as you can otherwise have compatibility issues. 
Current versions are:

- Ubuntu 20.04
- Webots 2022b
- ROS noetic

You are welcome to install these yourself but initially we recommend that you use the pre-configured image that we supply.
This image can be run as either a virtual machine or live booted from a USB.

## Download

Download the image file from [HERE](https://livecoventryac-my.sharepoint.com/:f:/g/personal/ac0745_coventry_ac_uk/Ehfn1bHMU7dNhkaOBAjBrs0Bq0Pn1vx-Ny9_E8D3EH_R3g?e=ZUZrKx).

## Verifying

If you have any issues with the files or just wish to check that they downloaded correctly, parity files are provided to allow for file validation and repair.

- If you are on Windows I suggest [QuickPar](https://www.quickpar.org.uk/).
- If Linux just `par2 v cavs.img.gz`.

## Flashing to usb

Download the image and flash using your preferred software.

[Balena etcher](https://www.balena.io/etcher/) is one option.

Boot menu access will depend on your specific machine but a fairly comprehensive list is available [HERE](https://www.disk-image.com/faq-bootmenu.htm)


## Booting in virtual machine

The image can be converted to run in a [VirtualBox](https://www.virtualbox.org/) virtual machine if preferred.
This is definitely the safer option but will have a performance hit. 

Download the image and convert to vdi format using Virtualbox.

- `VBoxManage convertdd cavs.img cavs.vdi`

Create a new virtual machine and use the new vdi file as the harddrive.

- Make sure to `Enable EFI` or the image will not boot.