-
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.
Add some reference docs and API docs
- Loading branch information
Showing
1 changed file
with
18 additions
and
2 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,5 +1,21 @@ | ||
# 1 - Java Programming | ||
# Java / roboRIO Programming | ||
|
||
## Introduction | ||
|
||
The [official WPILib documentation](https://docs.wpilib.org/en/stable/) has the most amount of content regarding FRC programming. Reading through the entire Wiki will set you ahead of majority of FRC programmers. Some components do not have official WPILib support and contain their documentation externally, such as [Phoneix 6](https://v6.docs.ctr-electronics.com/en/stable/) and [NavX2](https://pdocs.kauailabs.com/navx-mxp/) | ||
The [official WPILib documentation](https://docs.wpilib.org/en/stable/) has the most amount of content regarding FRC programming. Reading through the entire Wiki will set you ahead of majority of FRC programmers. Some components do not have official WPILib support and contain their documentation externally, such as [Phoenix 6](https://v6.docs.ctr-electronics.com/en/stable/) and [NavX2](https://pdocs.kauailabs.com/navx-mxp/) | ||
|
||
## Library guides | ||
|
||
* WPILib | ||
* [Basic Programming](https://docs.wpilib.org/en/stable/docs/software/basic-programming/index.html) | ||
* [Command-Based Programming](https://docs.wpilib.org/en/stable/docs/software/commandbased/index.html) | ||
* [Kinematics and Odometry](https://docs.wpilib.org/en/stable/docs/software/kinematics-and-odometry/index.html) | ||
* [CTRE Phoenix 6](https://v6.docs.ctr-electronics.com/en/stable/index.html) | ||
* [PathPlanner](https://pathplanner.dev/home.html) | ||
|
||
## API references | ||
|
||
* [WPILib (`edu.wpi.first`)](https://github.wpilib.org/allwpilib/docs/release/java/index.html) | ||
* [CTRE Phoenix 6 (`com.ctre.phoenix6`)](https://api.ctr-electronics.com/phoenix6/release/java/) | ||
* [PathPlannerLib (`com.pathplanner.lib`)](https://pathplanner.dev/api/java/) | ||
* [FRC-REVLib (`com.revrobotics`)](https://codedocs.revrobotics.com/java/) |