Update README.md

garrettsummerfi3ld · Feb 28, 2024 · 9fe2b76 · 9fe2b76
1 parent 0b80271
commit 9fe2b76
Showing 1 changed file with 44 additions and 15 deletions.
diff --git a/README.md b/README.md
@@ -1,31 +1,56 @@
-# Oakville Dynamics FRC Robot Template
+# gigan
 
-A template for FRC robots using GradleRIO and WPILib. Prepackaged with GitHub Actions for CI/CD, Qodana for static analysis, CodeQL for static analysis and security scanning, Spotless for code formatting, and Gradle Validation for validating the Gradle wrapper.
+A 2024 Cresendo FRC robot written in Java using GradleRIO and WPILib. Focus on stability and rich diagnostics for driver operation.
 
 ## Build Status
 
-| Action            | Status                                                                                                                                                                                                                                                 |
-| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| Build             | [![Build](https://github.com/OakvilleDynamics/frc-robot-template/actions/workflows/build.yml/badge.svg)](https://github.com/OakvilleDynamics/frc-robot-template/actions/workflows/build.yml)                                                           |
-| Qodana            | [![Qodana](https://github.com/OakvilleDynamics/frc-robot-template/actions/workflows/qodana.yml/badge.svg)](https://github.com/OakvilleDynamics/frc-robot-template/actions/workflows/qodana.yml)                                                        |
-| CodeQL            | [![CodeQL Scanning](https://github.com/OakvilleDynamics/frc-robot-template/actions/workflows/codeql.yml/badge.svg)](https://github.com/OakvilleDynamics/frc-robot-template/actions/workflows/codeql.yml)                                               |
-| Spotless          | [![Syntax Check](https://github.com/OakvilleDynamics/frc-robot-template/actions/workflows/syntax-check.yml/badge.svg)](https://github.com/OakvilleDynamics/frc-robot-template/actions/workflows/syntax-check.yml)                                      |
-| Gradle Validation | [![Validate Gradle Wrapper](https://github.com/OakvilleDynamics/frc-robot-template/actions/workflows/gradle-wrapper-validation.yml/badge.svg)](https://github.com/OakvilleDynamics/frc-robot-template/actions/workflows/gradle-wrapper-validation.yml) |
+| Action            | Status                                                                                                                                                                                                                           |
+| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Build             | [![Build](https://github.com/garrettsummerfi3ld/gigan/actions/workflows/build.yml/badge.svg)](https://github.com/garrettsummerfi3ld/gigan/actions/workflows/build.yml)                                                           |
+| Qodana            | [![Qodana](https://github.com/garrettsummerfi3ld/gigan/actions/workflows/qodana.yml/badge.svg)](https://github.com/garrettsummerfi3ld/gigan/actions/workflows/qodana.yml)                                                        |
+| CodeQL            | [![CodeQL Scanning](https://github.com/garrettsummerfi3ld/gigan/actions/workflows/codeql.yml/badge.svg)](https://github.com/garrettsummerfi3ld/gigan/actions/workflows/codeql.yml)                                               |
+| Spotless          | [![Syntax Check](https://github.com/garrettsummerfi3ld/gigan/actions/workflows/syntax-check.yml/badge.svg)](https://github.com/garrettsummerfi3ld/gigan/actions/workflows/syntax-check.yml)                                      |
+| Gradle Validation | [![Validate Gradle Wrapper](https://github.com/garrettsummerfi3ld/gigan/actions/workflows/gradle-wrapper-validation.yml/badge.svg)](https://github.com/garrettsummerfi3ld/gigan/actions/workflows/gradle-wrapper-validation.yml) |
 
 ## How to use
 
-1. Create a template of this repository
-2. Follow GitHub prompts for creating a repository
-3. Clone newly created repository
-4. Open the project in your WPILib Visual Studio Code (VS Code) after cloning
-5. Start hacking away!
+Download the repository and prep for deployment.
+
+```bash
+git clone https://github.com/garrettsummerfi3ld/gigan.git
+
+# On macOS/Linux
+chmod +x ./gradlew
+
+# To build and load dependencies
+./gradlew build
+```
+
+Ensure you are connected to a roboRIO via Wi-Fi or USB direct connect.
+
+> [!TIP]
+>
+> It is recommended to open up Visual Studio Code with WPILib or [WPILib's distribution of VS Code](https://github.com/wpilibsuite/allwpilib) for easier access to diagnostic tools and console logs, as well as GradleRIO being default included.
+
+Deploy the software to the roboRIO.
+
+```bash
+./gradlew deploy
+```
+
+_If you are using the WPILib extension:_
+
+- `Ctrl+Shift+P` (Windows/Linux) / `Command(⌘)+Shift+P` (macOS)
+- WPILib: Deploy Robot Code
 
 > [!NOTE]
 >
-> You should also change the `README.md` file to reflect your project for build statuses and other badges, otherwise the CI jobs listed here will point to the template. Include other changes that are made to help users understand your project.
+> You can also access commonly used WPILib commands when clicking on the WPILib icon on an open file, this only shows up if you have WPILib VS Code opened
 
 ## Features
 
+### Code features and quality gates
+
 - Preconfigured setup for GitHub Actions (helpful for [CI/CD](https://en.wikipedia.org/wiki/CI/CD))
   - Build action for building the robot code (helpful for ensuring code compiles)
   - [Qodana](https://www.jetbrains.com/qodana/) action for static analysis (helpful for finding bugs and code smells)
@@ -36,6 +61,10 @@ A template for FRC robots using GradleRIO and WPILib. Prepackaged with GitHub Ac
 - [Dependabot](https://docs.github.com/en/code-security/dependabot) for dependency updates (helpful for keeping dependencies up to date)
 - Preconfigured setup for [Spotless](https://github.com/diffplug/spotless) inside of Gradle (helpful for keeping code cleanly formatted during development)
 
+### Robot features
+
+[TBD]
+
 ## Requirements
 
 - WPILib 2024.3.1