From 28e5bea6f5b3e900a6bbd1cccf17c4783fa477d7 Mon Sep 17 00:00:00 2001 From: nifrali Date: Thu, 9 Oct 2025 12:17:59 -0500 Subject: [PATCH] Updated README file with some formatting help from AI --- README.md | 147 +++++++++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 130 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 1d682dd..dfcd32c 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,141 @@ -# 65266 Lego Dynamics - UNEARTHED Season Repository +# ๐Ÿค– 65266 Lego Dynamics - UNEARTHED Season -## Project Overview +
-This repository contains the Pybricks code for Team 65266 Lego Dynamics' robot for the UNEARTHED season. +**โšก Competitive Robotics Code for FLL SUBMERGEDโ„  Season โšก** -## Robot Hardware +![Team](https://img.shields.io/badge/Team-65266%20Lego%20Dynamics-blue?style=for-the-badge) +![Season](https://img.shields.io/badge/Season-UNEARTHED-green?style=for-the-badge) +![License](https://img.shields.io/badge/License-GPL-red?style=for-the-badge) -* **Robot Name:** Optimus Prime III -* **Robot Firmware:** PyBricks firmware -* **Motors:** Two large motors for attachments, C left, D right, Two small motors for drive, A left, B right -* **Sensors:** visible up-facing color sensor for quick starts -* **Attachments:** Lots of 'em +
-## Code Structure +--- -Files are the different runs we do, with each run consisting of one or multiple mission completions. Another script combines these files into a "master" file, which then adds the color-sensor-to-start logic. +## ๐Ÿ“‹ Project Overview -## How to Use +Welcome to the official code repository for **Team 65266 Lego Dynamics**! This repository contains all the Pybricks code powering our robot through the UNEARTHED season missions. Our modular approach allows for flexible mission execution and quick color-sensor-based run selection. -Load the master file into PyBricks, then send it over to the robot. Then you hold a color LEGO up to the sensor to start it. +--- -## License -GNU General Public License +## ๐Ÿฆพ Robot Hardware -You can take inspiration from our code, but you can't take our exact code. +### ๐ŸŽฏ Meet Optimus Prime III -Read LICENSE for more information. \ No newline at end of file +| Component | Specification | +|-----------|--------------| +| ๐Ÿค– **Robot Name** | Optimus Prime III | +| ๐Ÿ’พ **Firmware** | Pybricks | +| ๐Ÿ”ง **Attachment Motors** | 2ร— Large Motors (Ports C & D) | +| ๐Ÿš— **Drive Motors** | 2ร— Small Motors (Ports A & B) | +| ๐Ÿ‘๏ธ **Sensors** | Up-facing Color Sensor (Quick Start) | +| ๐Ÿ› ๏ธ **Attachments** | Multiple mission-specific tools | + +### โš™๏ธ Motor Configuration +- **Port A**: Left Drive Motor (Small) +- **Port B**: Right Drive Motor (Small) +- **Port C**: Left Attachment Motor (Large) +- **Port D**: Right Attachment Motor (Large) + +--- + +## ๐Ÿ“‚ Code Structure + +Our codebase is organized for maximum efficiency and modularity: + +``` +๐Ÿ“ฆ Repository + โ”ฃ ๐Ÿ“œ run_1.py # Individual mission runs + โ”ฃ ๐Ÿ“œ run_2.py # Each file = 1+ mission completions + โ”ฃ ๐Ÿ“œ run_3.py + โ”ฃ ๐Ÿ“œ ... + โ”— ๐Ÿ“œ master.py # ๐ŸŽฏ Combined master file with color-start logic +``` + +### ๐Ÿ”„ Workflow +1. **Individual Run Files** โ†’ Contain specific mission sequences +2. **Script Combination** โ†’ Merges runs into master file +3. **Color Sensor Logic** โ†’ Adds intelligent run selection based on color detection + +--- + +## ๐Ÿš€ How to Use + +### ๐Ÿ“ฅ Installation & Deployment + +1. **Load the Code** + ```bash + # Open the master.py file in Pybricks IDE + ``` + +2. **๐Ÿ”Œ Connect to Robot** + - Pair your robot via Bluetooth in Pybricks + +3. **๐Ÿ“ค Upload to Robot** + - Click "Download and Run" or send the program to the robot + +4. **๐ŸŽจ Start Your Run** + - Hold a colored LEGO brick up to the color sensor + - Different colors trigger different mission runs! + +### ๐ŸŽฎ Color Start System + +| ๐ŸŸฅ Red | ๐ŸŸฆ Blue | ๐ŸŸฉ Green | ๐ŸŸจ Yellow | +|--------|---------|----------|-----------| +| Run 1 | Run 2 | Run 3 | Run 4 | + +> **๐Ÿ’ก Pro Tip**: Organize your colored bricks before the match for quick run selection! + +--- + +## ๐Ÿ† Competition Notes + +- โฑ๏ธ **Quick Start**: Color sensor enables rapid run switching without reprogramming +- ๐ŸŽฏ **Modular Design**: Easy to test and modify individual missions +- ๐Ÿ”ง **Flexible Attachments**: Multiple tools optimized for different challenges + +--- + +## ๐Ÿค Contributing + +Team members can contribute by: +- ๐Ÿ› Reporting bugs via Issues +- ๐Ÿ’ก Suggesting mission optimizations +- ๐Ÿงช Testing new attachment designs +- ๐Ÿ“ Documenting successful strategies + +--- + +## ๐Ÿ“„ License + +**GNU General Public License v3.0** + +``` +๐Ÿ”’ You can take inspiration from our code, but you can't take our exact code. +``` + +This project is licensed under GPL-3.0 - see the [LICENSE](LICENSE) file for complete details. + +### ๐Ÿ“– What This Means: +- โœ… Learn from our approaches and strategies +- โœ… Understand our logic and algorithms +- โŒ Don't copy-paste our exact code +- โœ… Create your own unique implementations + +--- + +## ๐Ÿ“ž Contact & Support + +**Team 65266 Lego Dynamics** + +Questions about our approach? Interested in collaboration? Reach out! + +--- + +
+ +**๐Ÿ”ง Built with Passion | ๐Ÿค– Powered by Pybricks | ๐Ÿ† Competing for Excellence** + +โญ Star this repo if you found it helpful! โญ + +
\ No newline at end of file -- 2.49.1