Skip to content

Commit

Permalink
Version bump
Browse files Browse the repository at this point in the history
  • Loading branch information
ssejrog committed Dec 13, 2021
1 parent ab8de0b commit fcaa790
Showing 1 changed file with 8 additions and 11 deletions.
19 changes: 8 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,21 @@
EZ-Template is a simple plug-and-play PROS template that handles drive base functions for VEX robots.

[EZ-Template Version](https://github.com/EZ-Robotics/EZ-Template): 2.0.0
[Example Project Version](https://github.com/EZ-Robotics/EZ-Template-Example): 1.0.0
[Example Project Version](https://github.com/EZ-Robotics/EZ-Template-Example): 1.0.1

[Autonomous routines that used EZ-Template](https://photos.app.goo.gl/yRwuvmq7hDoM4f6EA)

## Downloading

Download the latest example project [here](https://github.com/EZ-Robotics/EZ-Template-Example/releases/latest) and open it as a new project in PROS.


## Setup
1) Download the latest example project [here](https://github.com/EZ-Robotics/EZ-Template-Example/releases/latest). Extract it, and open it in PROS.
## Download and Installation
1) Download the latest example project [here](https://github.com/EZ-Robotics/EZ-Template-Example/releases/latest). Extract the zip, and open it in PROS.
2) In `src/main.cpp`, configure drive and IMU ports to what they are on your robot. Be sure to read the comments!
3) Configure your wheel size and cartrige. Remember that 4" omni wheels are actually 4.125!
4) In `src/main.cpp`, at the bottom in `void opcontrol()`, decide how you'd like to control your robot! Any flavor of arcade or tank!
5) Turn the robot on and use it in driver control. Make sure the ports are correct and reversed correctly!
6) To test the test autonomous modes, plug into a competition switch and select the autonomous mode on the brain screen by pressing the left and right buttons! The current page will be the autonomous that runs. For making new autonomous routines, check `src/autons.cpp` for examples on how to use the drive functions.

## Upgrading
Note* this only works for 2.0.0 and beyond. You cannot upgrade from 1.X.X to 2.X.X.
1) Download the most recent [EZ-Template here](https://github.com/EZ-Robotics/EZ-Template/releases/latest).
*Note: this only works for 2.0.0 and beyond. You cannot upgrade from 1.X.X to 2.X.X.*
1) Download the most recent EZ-Template [here](https://github.com/EZ-Robotics/EZ-Template/releases/latest).
2) In your terminal, `cd` into the directory you downloaded the file.
3) Run this command from terminal `prosv5 c fetch [email protected]`.
4) `cd` into your pros project directory in your terminal.
Expand All @@ -36,8 +31,10 @@ Note* this only works for 2.0.0 and beyond. You cannot upgrade from 1.X.X to 2.
## Docs
[Read the docs here!](https://ez-robotics.github.io/EZ-Template/docs)

## Additing Autonomous Routines
[Check out the tutorial on adding new autonomous routines here!](https://ez-robotics.github.io/EZ-Template/docs/Tutorials/autons.html)

## License

## License
This project is licensed under the Mozilla Public License, version 2.0 - see the [LICENSE](LICENSE)
file for the full license.

0 comments on commit fcaa790

Please sign in to comment.