Skip to content

Update README to discuss vendor-{ctre,rev} #135

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

Merged
kcooney merged 2 commits into from
Feb 11, 2026
Merged

Update README to discuss vendor-{ctre,rev} #135

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
46e2eb0
Update README to discuss vendor-{ctre,rev}
kcooney Feb 10, 2026
861e13a
Each dash in the library name in the libs.versions.toml becomes a period
kcooney Feb 11, 2026
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
40 changes: 21 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,17 @@

### Updating your dependencies

In your project's "gradle" directory, create a file named `libs.versions.toml` with the following content:
In your project's "gradle" directory, create a file named `libs.versions.toml` with the following
content:

```toml
[versions]
lib2813 = "2.0.0-rc-2"
lib2813 = "2.0.0-rc-3"

[libraries]
lib2813-lib = { module = "com.team2813.lib2813:lib", version.ref="lib2813" }
lib2813-vendor-ctre = { module = "com.team2813.lib2813:vendor-ctre", version.ref="lib2813" }
lib2813-vendor-rev = { module = "com.team2813.lib2813:vendor-rev", version.ref="lib2813" }
lib2813-vision = { module = "com.team2813.lib2813:vision", version.ref="lib2813" }
lib2813-limelight = { module = "com.team2813.lib2813:limelight", version.ref="lib2813" }
lib2813-testing = { module = "com.team2813.lib2813:testing", version.ref="lib2813" }
Expand All @@ -21,38 +24,37 @@ In your `build.gradle`, update the `dependencies` section:

```groovy
dependencies {
// Existing dependencies
// Existing dependencies here

// Lib2813 dependencies
implementation libs.lib2813.lib
implementation libs.lib2813.vendor.ctre
implementation libs.lib2813.vendor.rev
implementation libs.lib2813.vision
implementation libs.lib2813.limelight
testImplementation libs.lib2813.testing
}
```

Note that you do not need to include all the dependencies. See the [Runtime dependencies](#runtime-dependencies)
section for details.

In addition be sure to include Maven Local in the list of repositories in your `build.gradle`
(needed until we publish to Maven Central):

```groovy
repositories {
mavenLocal()
mavenCentral()
}
```
Note: You do not need to include all the dependencies. For example, if you don't use REV Robotics
hardware (i.e. you don't have `REVLib.json` in your `vendordeps` directory) then you do not need
to add `libs.lib2813.vendor-rev` to your dependencies.

### Upgrading

To upgrade the version of the lib2813 libraries you are using, simply update the version string for "lib2813" in
`libs.versions.toml`.
To upgrade the version of the lib2813 libraries you are using, simply update the version string for
"lib2813" in `libs.versions.toml`.

### Vendordeps

- `com.team2813.lib2813:lib`:
- `WPILibNewCommands.json`
- `Phoenix6.json` (if using Phoenix motors)
- `REVLib.json` (if using REV Robotics motors)
- `com.team2813.lib2813:vendor-ctre`:
- `Phoenix6.json`
- `com.team2813.lib2813:vendor-ctre`:
- `REVLib.json`
- `com.team2813.lib2813:limelight`:
- `Phoenix6.json`
- `com.team2813.lib2813:vision`:
- `photonlib.json`
- `com.team2813.lib2813:testing`:
Expand Down