diff --git a/README.md b/README.md index cee22765..6ec8c6c1 100644 --- a/README.md +++ b/README.md @@ -2,41 +2,63 @@ ![](https://github.com/EZ-Robotics/EZ-Template/workflows/Build/badge.svg) [![License: MPL 2.0](https://img.shields.io/badge/License-MPL%202.0-brightgreen.svg)](https://opensource.org/licenses/MPL-2.0) -**EZ-Template is a simple plug-and-play PROS template that handles drive base functions, autonomous selector, input curves, and active brake with PTO support.** +⚡️ **coding made ez** ⚡️ -## Features -- Simple to setup -- PID for driving, turning, swing turns, and arcs -- Easy to use PID tuner -- Speed ramp-up for driving -- Asynchronous PID with blocking functions until settled and until a specific position has come -- Joystick input curves -- Live adjustment of input curves -- Basic autonomous selector -- SD card saving of autonomous selector and joystick curves -- "Tug of war" detection for autonomous -- PID exit conditions for when drive motors overheat -- Tank drive, single stick arcade, and dual stick arcade -- Loading animation during IMU calibration -- 3 wire encoder and rotation sensor support -- Add / remove motors from the drive dynamically to allow for PTO use -- Exposed PID class for use with your other subsystems -- Exposed slew class for gradual speed ramp-up for your other subsystems +💅 **docs and tutorials** 💅 + +💥 **pid, odometry, pure pursuit, boomerang** 💥 + +📚 **focus on consistency** 📚 + +🧐 **out of the box documentation** 🧐 + +🔌 **plug and play example project** 🔌 + +[See a complete playlist of EZ-Template autons here!](https://www.youtube.com/playlist?list=PLyZbi14KopZK70GTSD5NpygoAcM2_ls7T) ## [Discord Server](https://discord.gg/EHjXBcK2Gy) -Need extra assistance using EZ-Template? Feel free to join our [Discord Server](https://discord.gg/EHjXBcK2Gy)! +Need extra assistance using EZ-Template? Feel free to join our [Discord Server](https://discord.gg/EHjXBcK2Gy)! + +## Features +EZ-Template is built with high attention to the user experience. + +* Built with 💜 and [PROS](https://pros.cs.purdue.edu/) + * Powerful open source Development platform for VEX V5 + * Customize and extend with other community PROS libraries +* 🔌 Example project is plug-and-play + * Simple to setup + * Get up and running in minutes +* 👀 Simple to use API + * PID for driving, turning, swing turns, and arcs + * Odometry with Pure Pursuit and Boomerang + * Asynchronous PID with blocking functions + * "Tug of war" detection + * Overheat detection and exiting + * Live PID tuning + * Tracking wheel support +* 📺 Autonomous selector + * Easy to add autons + * SD card saving +* 🎮 Joystick control + * Tank drive, single stick arcade, and dual stick arcade + * Joystick input curves + * Adjust joystick curves live through the controller +* PID for your own subsystems +* Slew for your own subsystems + -## [Installation](https://ez-robotics.github.io/EZ-Template/tutorials/installation) -Installation tutorials can be found [here](https://ez-robotics.github.io/EZ-Template/tutorials/installation). +## Design Principles +* **Quick to get going.** EZ-Template should make it easy to learn and use. Anything is achievable by users, even if it takes them more code and more time to write. +* **Intuitive.** Users will not feel overwhelmed when looking at an EZ-Template project or adding new features. It should look intuitive and easy to build on top of. +* **Sensible Defaults.** Common and popular performance optimizations and configurations will be done for users, but only with the option to override them. -## [Upgrading](https://ez-robotics.github.io/EZ-Template/tutorials/upgrading) -Upgrading tutorials can be found [here](https://ez-robotics.github.io/EZ-Template/tutorials/upgrading). +We believe that, as developers, knowing how a library works helps us become better at using it. We're dedicating effort to creating tutorials and documentation with the hope that reading it will gain the user a deeper understanding of the tool, and become even more proficient in using it. -## [Tutorials](https://ez-robotics.github.io/EZ-Template/category/tutorials) -Tutorials on how to use and install EZ-Template can be found [here](https://ez-robotics.github.io/EZ-Template/category/tutorials). +## [Support me on Patreon!](https://www.patreon.com/roboticsisez) +Supporting me on Patreon will help guarantee that EZ-Template continues to get maintained and allow me to develop products for teams to use. [Click here](https://www.patreon.com/roboticsisez) to see my Patreon! -## [Docs](https://ez-robotics.github.io/EZ-Template/category/docs) -Documentation on how to use EZ-Template functions can be found [here](https://ez-robotics.github.io/EZ-Template/category/docs). +## [Download and Installation](https://ez-robotics.github.io/EZ-Template/tutorials/installation) +Learn how to install and setup EZ-Template [here](https://ez-robotics.github.io/EZ-Template/tutorials/installation)! ## [License](https://opensource.org/licenses/MPL-2.0) -This project is licensed under the Mozilla Public License, version 2.0 - see the [LICENSE](https://opensource.org/licenses/MPL-2.0) file for the full license. +This project is licensed under the Mozilla Public License, version 2.0 - see the [LICENSE](https://opensource.org/licenses/MPL-2.0) file for the full license. \ No newline at end of file