Welcome!

Getting started

You should have vagrant and virtualbox installed on your machine. If you're space-constrained, see here.

1. Clone this repo
   git clone https://github.com/Bruin-Spacecraft-Group/fcmcfc/
2. Update git submodules git submodule update --init --recursive
3. From the repo root directory, run vagrant up
   1. Vagrant will pull the Kubos virtualbox and boot it
4. Once 2 returns, run vagrant ssh, which performs an ssh into the VM.

Your CLI prompt should now have 'vagrant' as its user. This means the virtual machine is up and running!

Shut down your VM with vagrant halt.

Repo layout

• kubos/
  • this is a submodule of https://github.com/kubos/kubos. On the VM, its also available under ~/.kubos

Editing files

Vagrant is set up such that the entire repo folder is shared under /vagrant on the virtual machine. Executing cd /vagrant in the VM brings you to that folder, and editing files on your host machine automatically carries over to the VM.

So, code in whatever vim/emacs/IDE setup you have on your host machine. Everything will be available on the VM. If you put code anywhere besides /vagrant on the VM, upgrading the VM will destroy your code.

Compiling

See here.

For testing, typically cargo build is enough. If you'd like to send your code to FC, see cross compilation

Connecting to the Beaglebone

See here.