Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
JaciBrunning committed Nov 3, 2015
1 parent 9c2d184 commit 231ff31
Showing 1 changed file with 34 additions and 9 deletions.
43 changes: 34 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,42 @@ robotics competition to produce and build their code without being limited to
the Eclipse IDE.

GradleRIO extracts the WPILib sources from the eclipse plugin and allows you to
use it with eclipse or IntelliJ IDEA. GradleRIO also allows you to build and
deploy your code to the RoboRIO without using eclipse.
use it with Eclipse, IntelliJ IDEA or any IDE of your choice. GradleRIO also allows you to build and
deploy your code to the RoboRIO from the command-line, or through the IDE.

## Basic Commands
- ```gradlew wpi``` will download and extract the latest version of WPILib directly from WPI's servers
- ```gradlew idea``` / ```gradlew eclipse``` will generate all the necessary files for your Development Environment workspace
- ```gradlew build``` will build your Robot Code
- ```gradlew deploy``` will build and deploy your code to the RoboRIO

* WPILib is downloaded and extracted using 'gradlew wpi'
* A workspace is setup using 'gradlew idea' or 'gradlew eclipse'
* Code is deployed using 'gradlew deploy' or 'gradlew deployIP' (deployIP for custom IP addresses)
* Robot Code or the RoboRIO can be restarted using 'gradlew robot' or 'gradlew reboot'
* Robot Code can be removed from the RoboRIO using 'gradlew cleanRIO'
### Toast-Specific commands
- ```gradlew toastDeploy``` will export Toast to your RoboRIO

*If you're using the ToastAPI, we'll also generate the Run Configurations for you!*
## Features
### Dependency Management
GradleRIO manages your Dependencies with ease. Dependencies can be fetched from either Maven or your local system, and can be packaged with your Robot Code into a single, universal JAR. This is done through the ```dependencies { }``` block in your ```build.gradle``` file.

Other files can be Deployed to your RoboRIO, too! This is done with the ```gradlerio.deployers``` array, which can take files from your FileSystem and deploy them to a target file on your RoboRIO.

Toast Users can enjoy easy dependency management done the modular way. Dependencies can be added to the ```dependencies { }``` block with the configuration ```toastLibrary``` or ```toastModule``` to be deployed to the appropriate folder directly on the RoboRIO, automatically!

### IDE Support
GradleRIO supports a multitude of IDEs, with Eclipse and IntelliJ IDEA being supported by default. It's as simple as running ```gradlew eclipse``` or ```gradlew idea``` to get your Development Environment.

If you're running Toast, we'll even generate Simulation, Verification and Remote-Debug configurations for you!

### Robot Deployment
GradleRIO is flexible with your Robot. When deploying code, GradleRIO will search for your RoboRIO on USB and Network Interfaces. If your RoboRIO is running on a Network that is not your FRC-Provided Radio (perhaps wired ethernet), you can even specify an IP Address to deploy to.

Because all of the deployment properties are stored in ```build.gradle```, if you decide to change Team Number or Robot Base Class, it's very simple to update this info and have deployment work without a hitch.

### Extensibility
GradleRIO runs on an underlying Gradle Build System, which is extremely extensible and is used by many professional software companies around the world. Gradle is stable, fast and flexible, with a huge community to back it. You can even write your own Plugins for Gradle if you really want to take control.

IntelliJ IDEA and the latest releases of Eclipse have Gradle support built in, allowing you to run all these commands without leaving your IDE. Alternatively, you can also use the Command Line to build and deploy your code, and is easily automatable.

## Download
To get GradleRIO, simply head to the [releases page](http://github.com/Open-RIO/GradleRIO/releases) and download the .zip file containing the archive. Extract it to your working directory and get coding!
To get GradleRIO, head to the [Releases Page](https://github.com/Open-RIO/GradleRIO/releases) and download the zip archive of the latest release.

*Note: Toast users should follow the guide on the [Toast Wiki](https://github.com/Open-RIO/ToastAPI/wiki) to get the Toasted version*

0 comments on commit 231ff31

Please sign in to comment.