Add README files for some subprojects and update various other docs (#8640)

Adds a section on design philosophy so we have something to point to
when people suggest features that aren't compatible with the way WPILib
is designed. Fixes some missed reorg changes (although the native-utils
link intentionally points to main as to be up-to-date in the future) and
generally cleans up any outdated information. Also includes wording
about supporting FTC. Per discussion in Slack, the LabVIEW wording has
been removed, and anything to do with LabVIEW is going to have to be
NI's job. And pursuant to #2757 and #5331, additional (light) developer
documentation has been added to some subprojects, mostly being a quick
summary of the what the project does and what it's for (or not for).

---------

Co-authored-by: sciencewhiz <sciencewhiz@users.noreply.github.com>
Co-authored-by: Joseph Eng <91924258+KangarooKoala@users.noreply.github.com>
This commit is contained in:
Gold856
2026-04-26 19:39:26 -04:00
committed by GitHub
parent a695865781
commit 97d0b15f7d
24 changed files with 213 additions and 445 deletions

View File

@@ -16,7 +16,7 @@ This command runs the C++ benchmarks on desktop.
./gradlew benchmark:runCpp
```
## Deploy to a roboRIO
## Deploy to a Systemcore
This project can only deploy over USB. If an alternate IP address is preferred, the `address` block in benchmark/build.gradle can be changed to point to another address.
@@ -30,19 +30,20 @@ This command deploys the C++ project with all dependencies statically linked.
./gradlew benchmark:deployStatic
```
This command deploys the Java project and all required dependencies. It also installs the JRE if it's not currently installed.
This command deploys the Java project and all required dependencies.
```bash
./gradlew benchmark:deployJava
```
Those commands won't start the robot executable, so you have to manually ssh in and start it. The following command will do that.
```bash
ssh lvuser@172.22.11.2 frcRunRobot.sh
ssh systemcore@robot.local sudo systemctl stop robot
ssh systemcore@robot.local sudo ~/robotCommand
```
Console log prints will appear in the terminal.
Deploying any of these to the roboRIO will disable the current startup project until it is redeployed.
Deploying any of these to a Systemcore will disable the current startup project until it is redeployed.
## Faster builds