vagrant/frc-cpp-vagrantfile
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Updated README with Configuration and Scripting sections

Browse Source
This commit is contained in:
Austen Adler 2015-01-05 07:13:06 -05:00
parent ced9aa5ac6
commit c63670f391
1 changed files with 16 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -1,19 +1,29 @@
# FRC C++ Vagrantfile # FRC C++ Vagrantfile
This project uses [Vagrant](https://www.vagrantup.com/) and creates a virtual machine to compile and build WPILib C++ code for FRC. The goal is to make and deploy code without requiring Eclipse. This is not an official method of making or deploying code, so use with caution. This project uses [Vagrant](https://www.vagrantup.com/) and creates a virtual machine to compile and build WPILib C++ code for FRC. The goal is to make and deploy code without requiring Eclipse. This is not an official method of building or deploying code, so use with caution. This should work with Windows, Mac, and Linux.
### Installation ### Installation
- Install the [latest version of Vagrant](https://www.vagrantup.com/downloads.html). For Ubuntu users, apt-get doesn't work because the version of Vagrant in the repositories is too old. - Install the [latest version of Vagrant](https://www.vagrantup.com/downloads.html). For Ubuntu users, apt-get doesn't work because the version of Vagrant in the repositories is too old.
- Clone the repository: `git clone git@github.com:stonewareslord/frc-cpp-vagrantfile.git` - Clone the repository: `git clone git@github.com:stonewareslord/frc-cpp-vagrantfile.git&&cd frc-cpp-vagrantfile`
- Edit the rRIO host address in `config/host`
- Copy source code to `src/`
- Start the virtual machine: `vagrant up` - Start the virtual machine: `vagrant up`
- The first time the machine is started, your computer must be connected to the internet. It will probably take a few minutes. - The first time the machine is started, your computer must be connected to the internet. It will probably take a few minutes.
- Once provisioning completes, log into the machine with `vagrant ssh`
### Configuration
- Set the roboRIO host in `config/host`
- Copy your code into `src/`
### Usage ### Usage
Once provisioning completes, log into the machine with `vagrant ssh`. Use the following commands to build and deploy your project:
- `build` - compiles the source code in `src` to `build/FRCUserProgram`. If there are errors in the source, they will be displayed and `FRCUserProgram` will be deleted. - `build` - compiles the source code in `src` to `build/FRCUserProgram`. If there are errors in the source, they will be displayed and `FRCUserProgram` will be deleted.
- `putkey` (optional) - Sends the public key to the roboRIO for passwordless deploying. - `putkey` (optional) - Sends the public key to the roboRIO for passwordless deploying.
- `deploy` - Uploads `FRCUserProgram` to the roboRIO. This will prompt for a password if putkey was not run (the default password is blank). - `deploy` - Uploads `build/FRCUserProgram` to the roboRIO. This will prompt for a password if putkey was not run (the default password is blank).
To stop the machine, run `vagrant halt` from the host computer. Start it back up with `vagrant up`.
### Scripting
If you would like to automate the build process, you can run the following command to build then deploy only if the build was successful:
```sh
ssh vagrant@127.0.0.1 -p 2222 -i /path/to/frc-cpp-vagrantfile/.vagrant/machines/default/virtualbox/private_key 'build&&deploy'
```
Changing /path/to/frc-cpp-vagrantfile to the path of the frc-cpp-vagrantfile directory.
### Issues ### Issues
- There is no way to automate updating wpilib - There is no way to automate updating wpilib