generated from OakvilleDynamics/frc-robot-template
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Redid the README title from the template to the actual robot. Modified the build status icons to point to this repository. Clarified "How to use" section for newcomers to pick up and use the code. Added a required internet connection due to online Gradle dependencies.
- Loading branch information
1 parent
fe34d2f
commit 653a22f
Showing
1 changed file
with
13 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,20 +1,23 @@ | ||
# Oakville Dynamics FRC Robot Template | ||
# Oakville Dynamics NewbieBot | ||
|
||
A robot for the new members to use and play around with. | ||
|
||
## 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) | | ||
| Action | Status | | ||
| -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| Build | [![Build](https://github.com/OakvilleDynamics/NewbieBot/actions/workflows/build.yml/badge.svg)](https://github.com/OakvilleDynamics/NewbieBot/actions/workflows/build.yml) | | ||
| Qodana | [![Qodana](https://github.com/OakvilleDynamics/NewbieBot/actions/workflows/qodana.yml/badge.svg)](https://github.com/OakvilleDynamics/NewbieBot/actions/workflows/qodana.yml) | | ||
| CodeQL | [![CodeQL Scanning](https://github.com/OakvilleDynamics/NewbieBot/actions/workflows/codeql.yml/badge.svg)](https://github.com/OakvilleDynamics/NewbieBot/actions/workflows/codeql.yml) | | ||
| Spotless | [![Syntax Check](https://github.com/OakvilleDynamics/NewbieBot/actions/workflows/syntax-check.yml/badge.svg)](https://github.com/OakvilleDynamics/NewbieBot/actions/workflows/syntax-check.yml) | | ||
|
||
## How to use | ||
|
||
1. Create a template of this repository | ||
2. Follow GitHub prompts for creating a repository | ||
3. Clone newly created repository | ||
1. Clone repository with GitHub Desktop or a `git clone https://github.com/OakvilleDynamics/NewbieBot.git` | ||
2. Open the project in your WPILib Visual Studio Code (VS Code) | ||
3. Start hacking away! | ||
|
||
## Requirements | ||
|
||
* WPILib 2023.4.3 | ||
* Working internet connection for Gradle dependencies |