mirror of
https://github.com/Squibid/rph.git
synced 2025-10-20 03:44:04 +00:00
feat(vendordep): add vendordep management
- Add vendordep add - Add vendordep remove - Add vendordep list - Refactor downloading
This commit is contained in:
42
README.md
Normal file
42
README.md
Normal file
@@ -0,0 +1,42 @@
|
||||
# RPS (Robot Pits Helper)
|
||||
Manage your FRC robot code the UNIX way.
|
||||
|
||||
## Quick Start
|
||||
Make a new project from a template
|
||||
```sh
|
||||
rph template -d MyNewRoboProject -l java -t commandbased -n 5438 -s false
|
||||
```
|
||||
If you'd like to learn more about the template subcmd just run `rph template -h`.
|
||||
Now let's go into the project and add a vendor dependency:
|
||||
```sh
|
||||
rph vendordep add photonlib-2025.3.1
|
||||
```
|
||||
And now we just need to build to make it download all the actual code:
|
||||
```sh
|
||||
gradle build
|
||||
```
|
||||
|
||||
## But Why?
|
||||
Well you probably shouldn't, but if you really want to learn more about how
|
||||
computers work this is a solid starting point. As for the creation of this
|
||||
project: it was made for two reasons:
|
||||
1. To alleviate my everlasting frustration with WPILIB's crappy uis
|
||||
2. To dust everyone in the YAMS speedrunning competition
|
||||
|
||||
## TODO
|
||||
- [x] template
|
||||
- [ ] vendordep
|
||||
- [ ] update installed vendor deps
|
||||
- [ ] get info about installed vendor deps
|
||||
- [ ] riolog listener, seems like the vscode extension does it which means
|
||||
there's no reason we can't >:)
|
||||
|
||||
- [ ] have to make sure wpilib is installed somewhere so that we can build
|
||||
projects without running the wpilib installer, this might take a bit
|
||||
of investigation
|
||||
- [ ] make a declaritive config? (really only seems useful for speedrunning or
|
||||
setting up multiple rookies machines for a new project)
|
||||
|
||||
- [ ] runner? (maybe idk though cause you can just use gradlew directly)
|
||||
no, but maybe we should document how to use gradle for the noobs who
|
||||
use the internet
|
Reference in New Issue
Block a user