Skip to content

Commit

Permalink
Added 2.1.1 release, fixed typo and updated upgrade instructions.
Browse files Browse the repository at this point in the history
  • Loading branch information
ssejrog committed Jan 19, 2022
1 parent f992549 commit dde66be
Show file tree
Hide file tree
Showing 5 changed files with 53 additions and 13 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Simple plug-and-play PROS template that handles drive base functions for VEX rob
## Download and Installation
1) Download the latest example project [here](https://github.com/EZ-Robotics/EZ-Template/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!
3) Configure your wheel size and cartridge. 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.
Expand All @@ -28,7 +28,7 @@ Simple plug-and-play PROS template that handles drive base functions for VEX rob
1) Download the most recent EZ-Template [here](https://github.com/EZ-Robotics/EZ-Template/releases/latest).
2) Move the file to your project.
3) Open terminal or command prompt, and `cd` into your projects directory.
4) Run this command from terminal `prosv5 c fetch [email protected].0.zip`.
4) Run this command from terminal `prosv5 c fetch [email protected].1.zip`.
5) Apply the library to the project `prosv5 c apply EZ-Template`.
6) Put `#include "EZ-Template/api.hpp"` in your `include/main.h`.

Expand Down
2 changes: 1 addition & 1 deletion docs/Releases/2.0.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ See our [release page](https://github.com/EZ-Robotics/EZ-Template/releases/tag/v
*Note: upgrading only works for 2.0.0 and beyond. You cannot upgrade from 1.X.X to 2.X.X.*
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!
3) Configure your wheel size and cartridge. 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.
10 changes: 5 additions & 5 deletions docs/Releases/2.0.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,16 +38,16 @@ void default_constants() {
## 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!
3) Configure your wheel size and cartridge. 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.

## Upgrade Existing Project
*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.
2) Move the file to your project.
3) Open terminal or command prompt, and `cd` into your projects directory.
4) Run this command from terminal `prosv5 c fetch [email protected]`.
5) Apply the library to the project `prosv5 c apply EZ-Template`.
6) Put `#include "EZ-Template/api.hpp"` in your `include/main.h`.
6) Put `#include "EZ-Template/api.hpp"` in your `include/main.h`.
10 changes: 5 additions & 5 deletions docs/Releases/2.1.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,16 +37,16 @@ void autonomous() {
## Download and Installation
1) Download the latest example project [here](https://github.com/EZ-Robotics/EZ-Template/releases/latest) called `Example Project.zip`. 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!
3) Configure your wheel size and cartridge. 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.

## Upgrade Existing Project
*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.
2) Move the file to your project.
3) Open terminal or command prompt, and `cd` into your projects directory.
4) Run this command from terminal `prosv5 c fetch [email protected]`.
5) Apply the library to the project `prosv5 c apply EZ-Template`.
6) Put `#include "EZ-Template/api.hpp"` in your `include/main.h`.
6) Put `#include "EZ-Template/api.hpp"` in your `include/main.h`.
40 changes: 40 additions & 0 deletions docs/Releases/2.1.1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
layout: default
title: Template 2.1.1
nav_order: 3
has_children: false
parent: Releases
---

## Table of contents
{: .no_toc .text-delta }

1. TOC
{:toc}


---

## EZ-Template 2.1.1 Release
Minor release that makes arcade control work.

## Changelog
See our [release page](https://github.com/EZ-Robotics/EZ-Template/releases/tag/v2.1.1) for a changelog.

## Download and Installation
1) Download the latest example project [here](https://github.com/EZ-Robotics/EZ-Template/releases/latest) called `Example Project.zip`. 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 cartridge. 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.

## Upgrade Existing Project
*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) Move the file to your project.
3) Open terminal or command prompt, and `cd` into your projects directory.
4) Run this command from terminal `prosv5 c fetch [email protected]`.
5) Apply the library to the project `prosv5 c apply EZ-Template`.
6) Put `#include "EZ-Template/api.hpp"` in your `include/main.h`.

0 comments on commit dde66be

Please sign in to comment.