update credits
[librepilot.git] / make / vagrant / vagrant_openpilot_dev / README
blob8e20eba3b921fd82a46bfdf7834b1f4ab3707b93
1 vagrant_openpilot_dev - provides a Vagrant box with everything needed to compile LibrePilot code base. 
3 username: vagrant
4 password: vagrant
6 For details of an LibrePilot development environment please refer to the Development Manual https://librepilot.atlassian.net/wiki/display/LPDOC/Linux+-+Building+and+Packaging.
8 To enable Android Studio and Java, edit file install-tools.sh and set ANDROID_ENV=true. You might also want to adjust for the versions it downloads.
10 If you would like for VirtualBox window to open, this can be useful for running apps, set 'vb.gui = true' in Vagrant file. For now the vagrant shell (ssh) will not work when starting in GUI mode.
12 Setting up
14 1) Install vagrant on your host (https://www.vagrantup.com/docs/installation/)
15 2) Download the files in this folder to a working folder on your host. There is no need to retrieve the full repository.
16 3) in a command line select the working folder
17 4) Run the command 
18 $ vagrant up
20 Once your machine has started up you can ssh into it or log into Xfce (assuming you set vb.gui = true). Any changes you make persist in the Vagrant VM, when you are done run 'vagrant halt', this will turn off the vm and persist your changes.
22 $ vagrant ssh
26 To begin with LibrePilot base source is checked out into ~/workspace/librepilot. All necessary modules are initialized and SDK's installed.
28 You are now ready to browse the code. To build the code run the commands:
29 $ cd ~/workspace/librepilot
30 $ make all
32 If you wish to start all over:
33 $ vagrant halt 
34 $ vagrant destroy
36 For more information about LibrePilot please visit the forums at https://forum.librepilot.org/.
38 For more information about Vagrant please visit https://www.vagrantup.com/.
40 Based off https://github.com/steveliles/vagrant-boxes/blob/master/debian-android-studio/install-tools.sh