Welcome To Team 1831E's Code Repo! 🔥🚀

Welcome Adventurer! This repository contains all the code and related documentation for our robotics projects, developed for VEX Robotics competitions.

If you decide to use our code, please consider starring our project to support us!

Special mention to Liam from Lemlib for creating an amazing tool that we based on!

License

This project is licensed under the MIT license. Check LICENSE for more details.

Table of Contents

• About Us
• Project Structure
• Getting Started
• Features
• How to Contribute
• License

---

About Us

Team 1831E is a currently active V5RC HS team based in The King's School, Paramatta, Sydney Australia competing in the VEX Robotics Competition 2024-2025 "High Stakes".

---

Project Structure

Here's an overview of the repository:

1831E-Robotics/
├── include/            # Header files for modular design  
│  
├── src/                # Source code for the robot  
│   ├── main.cpp            # Main entry point of the program  
│   ├── controls.cpp        # Code for specific robot subsystems (e.g., drive, lift, claw)  
│   └── robot-config.cpp    # Mostly constructurs for initiating robot devices & sensors
│
└── README.md           # Repository overview  

---

Getting Started

Prerequisites

Before running the code, ensure you have the following installed:

• PROS API (https://pros.cs.purdue.edu/) *Recommended through VSCode Extension
• VEX V5 Brain and Controller
• Robot configured with necessary hardware components.

Installation

1. Clone the repository to your local machine:

   git clone https://github.com/LycoKodo/1831E-Robotics.git  

2. Open the project in VScode

3. Build and deploy the code to the robot. with "pros mu"

---

Features

• Autonomous Modes: Optimized routines for various competition scenarios.
• Driver Control: Streamlined controls for intuitive operation.
• Subsystem Modularity: Easy-to-modify subsystems for efficient development.
• Error Handling: Robust mechanisms to detect and handle runtime issues.

---

How to Contribute

We welcome contributions! To contribute:

1. Fork the repository.
2. Create a feature branch:

   git checkout -b feature-name  

3. Commit your changes:

   git commit -m "Add feature-name"  

4. Push your changes and create a pull request! (Thanks for contributing!)

---

License

This project is licensed under the MIT License. See the LICENSE file for details.

---

Thanks for reading this, I use arch btw!

Cheers! 🍻 Alex Cai (LycoKodo) - Programmer of 1831E