Rename myRobot to developerRobot and move docs to subproject (#6283)

This commit is contained in:
Tyler Veness
2024-05-24 10:41:23 -07:00
committed by GitHub
parent 65f4505e3c
commit ae655a3a71
10 changed files with 85 additions and 53 deletions

43
developerRobot/README.md Normal file
View File

@@ -0,0 +1,43 @@
# Developer Robot
This is a robot project built directly against this repo's sources. It builds the minimum required for deploying to a roboRIO, so it's faster than publishing the whole library to Maven first.
This command builds everything.
```bash
./gradlew developerRobot:build
```
## Simulation
This command runs the C++ subproject on desktop.
```bash
./gradlew developerRobot:runCpp
```
## Deploy to a roboRIO
This project can only deploy over USB. If an alternate IP address is preferred, the `address` block in developerRobot\build.gradle can be changed to point to another address.
This command deploys the C++ project using shared dependencies. Prefer this one for most C++ development.
```bash
./gradlew developerRobot:deployShared
```
This command deploys the C++ project with all dependencies statically linked.
```bash
./gradlew developerRobot:deployStatic
```
This command deploys the Java project and all required dependencies. It also installs the JRE if it's not currently installed.
```bash
./gradlew developerRobot: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
```
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.