Update README

README.md

@@ -1,17 +1,150 @@
 # GRRBase
-A template repository for Java-based robots in the FIRST Robotics Competition.
 
-### Code Styling
-All Java code follows the styling guide of [Prettier](https://prettier.io/). You can apply these rules via [Spotless](https://github.com/diffplug/spotless/tree/main) using the command `./gradlew spotlessApply`.
+A template repository for Java-based robots in the FIRST Robotics Competition.
 
-### Highlights
+## Highlights
 
-- [Swerve API](https://github.com/Greater-Rochester-Robotics/GRRBase/blob/main/src/main/java/org/team340/lib/swerve/SwerveAPI.java)
+- [Swerve API](src/main/java/org/team340/lib/swerve/SwerveAPI.java)
 
     Supports various hardware configurations, from vendors such as CTRE, REV, and Redux Robotics, with features such as high frequency odometry, a custom ratelimiter to improve driver control while also reducing wheel scrub, and built-in support for tuning the drivetrain's configuration live via NetworkTables.
 
-- [Pre-defined Loggers](https://github.com/Greater-Rochester-Robotics/GRRBase/tree/main/src/main/java/org/team340/lib/logging)
+- [Pre-defined Loggers](src/main/java/org/team340/lib/logging)
+
+    Utilizing Epilogue, an annotation-based logging framework, custom loggers for vendor and WPILib APIs are pre-defined to transparently log relevant data from the robot's hardware.
+
+- [Various other utilities](src/main/java/org/team340/lib/util)
+
+## Getting Started
+
+### Creating your repository
+
+1. On GitHub, navigate to the main page of this repository.
+2. Above the file list, click *Use this template*.
+3. Select *Create a new repository*.
+
+*See also: [GitHub Docs](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template)*
+
+### Prerequisites
+
+- [WPILib](https://github.com/wpilibsuite/allwpilib/releases) 2025.x
+- [Node.js](https://nodejs.org/en/download) (v22 LTS Recommended)
+
+Node.js is required to support linting via [Spotless](https://github.com/diffplug/spotless), using the [Prettier](https://prettier.io) style guide. You can apply these rules by building, or by running `./gradlew spotlessApply`. Alternatively, if you wish to disable code formatting, you can do so with the following modifications to [build.gradle](build.gradle):
+
+<details>
+
+<summary>Expand</summary>
+
+<br>
+
+```diff
+diff --git a/build.gradle b/build.gradle
+index 155f017..7670ad8 100644
+--- a/build.gradle
++++ b/build.gradle
+@@ -1,7 +1,6 @@
+ plugins {
+     id "java"
+     id "edu.wpi.first.GradleRIO" version "2025.3.2"
+-    id "com.diffplug.spotless" version "7.0.2"
+ }
+
+ java {
+@@ -83,30 +82,6 @@ dependencies {
+     implementation 'com.google.code.gson:gson:2.11.0'
+ }
+
+-// Code formatting via spotless
+-spotless {
+-    java {
+-        target fileTree('.') {
+-            include '**/*.java'
+-            exclude '**/build/**', '**/build-*/**'
+-        }
+-
+-        toggleOffOn()
+-        endWithNewline()
+-        removeUnusedImports()
+-        trimTrailingWhitespace()
+-        prettier(['prettier': '3.4.2', 'prettier-plugin-java': '2.6.7'])
+-            .config([
+-                'parser': 'java',
+-                'plugins': ['prettier-plugin-java'],
+-                printWidth: 120,
+-                tabWidth: 4,
+-                useTabs: false,
+-                trailingComma: "none"
+-            ])
+-    }
+-}
+-
+ test {
+     useJUnitPlatform()
+     systemProperty 'junit.jupiter.extensions.autodetection.enabled', 'true'
+@@ -134,5 +109,4 @@ wpi.java.configureTestTasks(test)
+ // Configure string concat to always inline compile
+ tasks.withType(JavaCompile) {
+     options.compilerArgs.add '-XDstringConcat=inline'
+-    dependsOn 'spotlessApply'
+ }
+```
+
+*You may also want to modify [robot-code.yml](.github/workflows/robot-code.yml) to remove the formatting check from CI:*
+
+```diff
+diff --git a/.github/workflows/robot-code.yml b/.github/workflows/robot-code.yml
+index 313b56e..4e26616 100644
+--- a/.github/workflows/robot-code.yml
++++ b/.github/workflows/robot-code.yml
+@@ -5,32 +5,6 @@ env:
+   NODE_VERSION: 20
+
+ jobs:
+-  format:
+-    name: Check Format
+-    runs-on: ubuntu-latest
+-    container: wpilib/ubuntu-base:22.04
+-
+-    steps:
+-      - name: Checkout Repository
+-        uses: actions/checkout@v4
+-        with:
+-          fetch-depth: 0
+-
+-      - name: Add repository to git safe directories
+-        run: git config --global --add safe.directory $GITHUB_WORKSPACE
+-
+-      - name: Setup Node
+-        uses: actions/setup-node@v4
+-        with:
+-          node-version: ${{ env.NODE_VERSION }}
+-          registry-url: https://registry.npmjs.org/
+-
+-      - name: Grant execute permission for gradlew
+-        run: chmod +x gradlew
+-
+-      - name: Check robot code formatting
+-        run: ./gradlew spotlessCheck
+-
+   build:
+     name: Build
+     runs-on: ubuntu-latest
+```
+
+</details>
+
+### Configuring the project for your team
+
+First, ensure [wpilib_preferences.json](.wpilib/wpilib_preferences.json) is configured for your team number:
+
+```json
+{
+    "teamNumber": 340
+}
+```
 
-    Utilizing Epilogue, an annotation-based logging framework, custom loggers for vendor and WPILib APIs are pre-defined to transparently log relevant data from the robot's hardware, without any extra setup required.
+*(Optional)* If you decide to modify the package name for your robot code (by default, `org.team340.robot`), you must update your [build.gradle](build.gradle) to reflect the new location of the project's `Main` class:
 
-- [Various other utilities](https://github.com/Greater-Rochester-Robotics/GRRBase/tree/main/src/main/java/org/team340/lib/util)
+```groovy
+def ROBOT_MAIN_CLASS = "com.example.robot.Main"
+```