spiri-sdk/README.md

# Ways of running

There are two main ways of running this software.

Most users are recomended to install [VirtualBox](https://www.virtualbox.org/), create a new
VM, and use the supplied VDI as the disk image. You will likely want 
to increase memory limits and CPU count above the default.

Advanced users can also use the SDK as a docker image. It pairs well with 
[distrobox](https://github.com/89luca89/distrobox) to better
integrate it with their existing linux workflows.

```bash
distrobox create --image git.spirirobotics.com/spiri/spiri-sdk-desktop:master
distrobox enter spiri-sdk-desktop-main
#You can optionally copy the standard SDK setup from /opt/spiri-sdk/user-home-skeleton/
# cp -r /opt/spiri-sdk/user-home-skeleton/* ~/
cd /opt/spiri-sdk/PX4-Autopilot/
make px4_sitl gazebo-classic #Start the simulator
```

You can also run a full init system, and it's own docker container, using

```bash
distrobox create --root \
  --image git.spirirobotics.com/spiri/spiri-sdk-desktop:master \
  --init \
  --unshare-all
```

# Building

```bash
#Note that because this is running in a container, the -o output flag must be relative to the current directory.
# We mount the current working directory in the docker container as part of this script.
./virtualize.sh build ./ -s 100gb  -o sdk.vdi
```

For testing the VM, I use the following

```bash
./virtualize.sh build ./ -s 100gb  -o sdk.qcow2
qemu-system-x87_64 -display default,show-cursor=on -enable-kvm  -device virtio-gpu -m 4g -smp 4 -hda sdk.qcow2
```