From d769427fee3e6a0ebe923ba9b1f972054ba59225 Mon Sep 17 00:00:00 2001 From: Thalia Webb Date: Tue, 16 Sep 2025 16:53:19 -0400 Subject: [PATCH 1/2] new instructions in readme --- README.md | 65 ++++++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 48 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index ce72dac6..e7b71f31 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,52 @@ -# Team 7652 -[![Build & Format Check](https://github.com/MiamiBeachBots/base-bot/actions/workflows/gradle-build.yml/badge.svg)](https://github.com/MiamiBeachBots/base-bot/actions/workflows/gradle-build.yml) +Team 7652 +Install -## Install -TODO +The official WPILib installer is the best way to get started. It handles setting up all the tools you need, including Visual Studio Code and the Java Development Kit (JDK). -## Build -TODO + Windows: Download and run the .iso installer from the WPILib website. Mount the disk image, then launch WPILibInstaller.exe. + + macOS: Download the .dmg installer and run the WPILibInstaller application. + + Linux: Download the .tar.gz file. Extract it and run the installer script from the terminal. + +Build + +To compile your code, you can use the built-in tools in Visual Studio Code or the command line. + + VS Code: Open the Command Palette (Ctrl + Shift + P) and select WPILib: Build Robot Code. + + Command Line: Open a terminal in the project's root directory and run the Gradle Wrapper script. + + macOS/Linux: ./gradlew build + + Windows: gradlew.bat build + +Update code on robot + +To get your new code onto the RoboRIO, you need to "deploy" it. Make sure your computer is connected to the robot via USB, Ethernet, or Wi-Fi. + + VS Code: Use the Command Palette (Ctrl + Shift + P) and select WPILib: Deploy Robot Code. + + Command Line: In your terminal, run the deploy command: + + macOS/Linux: ./gradlew deploy + + Windows: gradlew.bat deploy -## Update code on robot TODO -## TODO - -- [x] Finish Gyro -- [x] Pathweaver/trajectory planning -- [x] Network Tables -- [x] Py Coprocessor -- [x] Basic Dashboard -- [ ] Fancy Dashboard -- [ ] Finish the readme -- [x] CAN support + + [x] Finish Gyro + + [x] Pathweaver/trajectory planning + + [x] Network Tables + + [x] Py Coprocessor + + [x] Basic Dashboard + + [ ] Fancy Dashboard + + [ ] Finish the readme + + [x] CAN support From 0ab9a863fbe20a32a3c41bbafe43d346c95d32b1 Mon Sep 17 00:00:00 2001 From: Thalia Webb Date: Tue, 16 Sep 2025 16:56:55 -0400 Subject: [PATCH 2/2] forgot the test --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e7b71f31..1bad167f 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ Team 7652 -Install +[![Build & Format Check](https://github.com/MiamiBeachBots/base-bot/actions/workflows/gradle-build.yml/badge.svg)](https://github.com/MiamiBeachBots/base-bot/actions/workflows/gradle-build.yml) + +Install WPILib The official WPILib installer is the best way to get started. It handles setting up all the tools you need, including Visual Studio Code and the Java Development Kit (JDK).