Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #1

Merged
merged 3 commits into from
Nov 18, 2024
Merged

Update README.md #1

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
769ff6c
Update README.md
sigalrmp Nov 17, 2024
8298178
typo
sigalrmp Nov 17, 2024
4272247
add instructions to make a repo from template
sigalrmp Nov 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 2 additions & 24 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,24 +1,2 @@
# Hydrogen
The SciBorgs' base repository. It is a living document that should be updated yearly for new libraries and other changes.

## Structure
Our robot code is centered around [Robot.java](src/main/java/org/sciborgs1155/robot/Robot.java).

This project currently contains drive, vision, and autos. You are expected to add/modify code supporting existing files and new subsystems when using this template. Some of these files include but are not limited to:
- **[Autos.java](src/main/java/org/sciborgs1155/robot/commands/Autos.java)** Add code for new subsystems in `configureAutos`, such as commands for `NamedCommands`
- **[DriveConstants.java](src/main/java/org/sciborgs1155/robot/drive/DriveConstants.java)** Modify control constants yearly for each new robot, and all drivetrain constants for each new drivetrain as needed.
- **[VisionConstants.java](src/main/java/org/sciborgs1155/robot/vision/VisionConstants.java)** Add new `CameraConfig` fields representing cameras on the robot, and change the `create` method in [Vision](src/main/java/org/sciborgs1155/robot/vision/Vision.java). Also modify any camera configurations or constants if needed.
- **[Constants.java](src/main/java/org/sciborgs1155/robot/Constants.java)** Modify the class `Field` to be updated for each year's game, and any other constants if needed.
- **[Ports.java](src/main/java/org/sciborgs1155/robot/Ports.java)** Modify existing OI and drive ports, as well as adding new ports.
- **[Robot.java](src/main/java/org/sciborgs1155/robot/Robot.java)** A lot: subsystems, command files, related triggers & bindings, interactions with other subsystems & files, library configurations/starting, etc..

## Dependencies
- [WPILib](https://docs.wpilib.org/)
- [REVLib](https://docs.revrobotics.com/sparkmax/software-resources/spark-max-api-information)
- [PathPlannerLib](https://pathplanner.dev/home.html)
- [PhotonLib](https://docs.photonvision.org/en/latest/docs/programming/photonlib/adding-vendordep.html)
- [Phoenix6](https://v6.docs.ctr-electronics.com/en/stable/)
- [URCL](https://github.com/Mechanical-Advantage/URCL)
- [NavX](https://pdocs.kauailabs.com/navx-mxp/software/roborio-libraries/java/)
- [Spotless](https://github.com/diffplug/spotless/blob/main/plugin-gradle/README.md)
- [Monologue](https://github.com/shueja/Monologue)
# SciGuides Robot Base
This is the base reposity used for projects in [SciGuides](https://github.com/SciBorgs/SciGuides). It is based on [Hydrogen](https://github.com/SciBorgs/Hydrogen), the base repository for the SciBorgs.
Loading