mirror of
https://github.com/wpilibsuite/allwpilib
synced 2026-06-19 00:41:43 +00:00
97d0b15f7d
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>
88 lines
2.9 KiB
Markdown
88 lines
2.9 KiB
Markdown
# Installing Development Builds
|
|
|
|
This article contains instructions on building projects using a development build and a local WPILib build.
|
|
|
|
**Note:** This only applies to Java/C++ teams.
|
|
|
|
> [!WARNING]
|
|
> **There are no stability or compatibility guarantees for builds outside of [tagged releases](https://github.com/wpilibsuite/allwpilib/releases). Changes may not be fully documented. Use them at your own risk!**
|
|
>
|
|
> Development builds may be non-functional between the end of the season and the start of beta testing. Development builds are also likely to be incompatible with vendor libraries during this time.
|
|
|
|
## Development Build
|
|
|
|
Development builds are the per-commit build hosted every time a commit is pushed to the [allwpilib](https://github.com/wpilibsuite/allwpilib/) repository. These builds are then hosted on [artifactory](https://frcmaven.wpi.edu/artifactory/webapp/#/home).
|
|
|
|
To build a project using a development build, find the build.gradle file and open it. Then, add the following code below the plugin section and replace YEAR with the year of the development version. It is also necessary to use a 2027 GradleRIO version, ie `2027.0.0-alpha-5`
|
|
|
|
```groovy
|
|
wpi.maven.useLocal = false
|
|
wpi.maven.useDevelopment = true
|
|
wpi.versions.wpilibVersion = 'YEAR.+'
|
|
```
|
|
|
|
The top of your ``build.gradle`` file should now look similar to the code below. Ignore any differences in versions.
|
|
|
|
Java
|
|
```groovy
|
|
plugins {
|
|
id "java"
|
|
id "org.wpilib.GradleRIO" version "2027.0.0-alpha-5"
|
|
}
|
|
|
|
wpi.maven.useLocal = false
|
|
wpi.maven.useDevelopment = true
|
|
wpi.versions.wpilibVersion = '2027.+'
|
|
```
|
|
|
|
C++
|
|
```groovy
|
|
plugins {
|
|
id "cpp"
|
|
id "google-test-test-suite"
|
|
id "org.wpilib.GradleRIO" version "2027.0.0-alpha-5"
|
|
}
|
|
|
|
wpi.maven.useLocal = false
|
|
wpi.maven.useDevelopment = true
|
|
wpi.versions.wpilibVersion = '2027.+'
|
|
```
|
|
|
|
### Development Build Documentation
|
|
|
|
* C++: https://github.wpilib.org/allwpilib/docs/development/cpp/
|
|
* Java: https://github.wpilib.org/allwpilib/docs/development/java/
|
|
|
|
## Local Build
|
|
|
|
Building with a local build is very similar to building with a development build. Ensure you have built and published WPILib by following the instructions attached [here](https://github.com/wpilibsuite/allwpilib#building-wpilib). Next, find the ``build.gradle`` file in your robot project and open it. Then, add the following code below the plugin section and replace ``YEAR`` with the year of the local version.
|
|
|
|
Java
|
|
```groovy
|
|
plugins {
|
|
id "java"
|
|
id "org.wpilib.GradleRIO" version "2027.0.0-alpha-5"
|
|
}
|
|
|
|
wpi.maven.useLocal = false
|
|
wpi.maven.useWpilibMavenLocalDevelopment = true
|
|
wpi.versions.wpilibVersion = 'YEAR.424242.+'
|
|
```
|
|
|
|
C++
|
|
```groovy
|
|
plugins {
|
|
id "cpp"
|
|
id "google-test-test-suite"
|
|
id "org.wpilib.GradleRIO" version "2027.0.0-alpha-5"
|
|
}
|
|
|
|
wpi.maven.useLocal = false
|
|
wpi.maven.useWpilibMavenLocalDevelopment = true
|
|
wpi.versions.wpilibVersion = 'YEAR.424242.+'
|
|
```
|
|
|
|
# Systemcore Development
|
|
|
|
See the [developerRobot](developerRobot/README.md) subproject.
|