Skip to content

Commit

Permalink
More documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
BrownGenius committed Sep 18, 2024
1 parent d350e4b commit b6c73aa
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 5 deletions.
4 changes: 0 additions & 4 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,6 @@ The code uses Java WPILib.
* [Git Tutorial](https://learngitbranching.js.org/)
* [Java Tutorial](https://youtube.com/playlist?list=PLZPZq0r_RZOMhCAyywfnYLlrjiVOkdAI1&si=ImrjG_c4-wThJqy3)

# Useful Resources:
* [Crescendo 2024 Main Electrical Components](https://docs.google.com/spreadsheets/d/1jhis3_a5TAV7oP3p6C41bP5yMevQPRnBtGeEiesHzKM)
* [Crescendo 2024 Hardware/Software Calibration](https://docs.google.com/document/d/1msJO2dKCxqzbMlSSOtfs8W_ITjltEbtXaQBxc-CpNMo)

# Getting Started
1. Install [WPILib](https://docs.wpilib.org/en/stable/docs/zero-to-robot/step-2/index.html)
1. Install Git
Expand Down
10 changes: 9 additions & 1 deletion src/main/java/frc/robot/config/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,12 @@ We had 3 different robots with different capabilities for dev/testing purposes:
2. Phoenix: Initial Swerve Drive + Vision Prototype
3. Inferno: Final Robot

A "RobotConfig" class
A [RobotConfig](RobotConfig.java) class defines all of the subsystems and corresponding constants required for a "robot". Each robot variant extends RobotConfig and instantiates the subsystems and overrides constants as needed.

| Robot | [Drive](../subsystems/drive/) | [Shooter](../subsystems/shooter/) | [Intake](../subsystems/intake/) | [Arm](../subsystems/arm/) | [Auto](../../../../deploy/pathplanner/) | [Climber](../subsystems/climber/) | [Vision](../subsystems/vision/) | [LED](../subsystems/led/) |
| --- | --- | --- | --- | --- | --- | --- | --- | --- |
| [Sherman](RobotConfigSherman.java) | Differential | SparkMax(2) | SparkMax(1) | TalonSRX(3) | No (stub) | No (stub) | No (stub) | No (stub) | No (stub) |
| [Phoenix](RobotConfigPhoenix.java) | Swerve(yagsl) | No (stub) | No (stub) | No (stub) | Yes | No (stub) | Shooter | No (stub) |
| [Inferno](RobotConfigInferno.java) | Swerve(yagsl) | SparkMax(2) | SparkMax(3) | SparkMax(4) | Yes | SparkMax(7) SparkMax(6) | Shooter Intake Right Left | Yes |


3 changes: 3 additions & 0 deletions src/main/java/frc/robot/subsystems/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Useful Resources:
* [Crescendo 2024 Main Electrical Components](https://docs.google.com/spreadsheets/d/1jhis3_a5TAV7oP3p6C41bP5yMevQPRnBtGeEiesHzKM)
* [Crescendo 2024 Hardware/Software Calibration](https://docs.google.com/document/d/1msJO2dKCxqzbMlSSOtfs8W_ITjltEbtXaQBxc-CpNMo)

0 comments on commit b6c73aa

Please sign in to comment.