From f656e992454ea0bb52f352e9de54357f69b01eca Mon Sep 17 00:00:00 2001 From: Tyler Veness Date: Mon, 14 Nov 2022 14:23:47 -0800 Subject: [PATCH] [readme] Add links to development build documentation (#4481) * Add links to development build documentation * Use GitHub dev docs links in readme badges --- OtherVersions.md => DevelopmentBuilds.md | 7 ++++++- README.md | 8 ++++---- 2 files changed, 10 insertions(+), 5 deletions(-) rename OtherVersions.md => DevelopmentBuilds.md (88%) diff --git a/OtherVersions.md b/DevelopmentBuilds.md similarity index 88% rename from OtherVersions.md rename to DevelopmentBuilds.md index 5c400b1e10..e452f3adf9 100644 --- a/OtherVersions.md +++ b/DevelopmentBuilds.md @@ -8,7 +8,7 @@ This article contains instructions on building projects using a development buil 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). -In order 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 2023 GradleRIO version, ie `2023.0.0-alpha-1` +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 2023 GradleRIO version, ie `2023.0.0-alpha-1` ```groovy wpi.maven.useLocal = false @@ -46,6 +46,11 @@ wpi.versions.wpilibVersion = '2023.+' wpi.versions.wpimathVersion = '2023.+' ``` +### 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. diff --git a/README.md b/README.md index e1a0d05d2e..3f262110f0 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # WPILib Project ![CI](https://github.com/wpilibsuite/allwpilib/workflows/CI/badge.svg) -[![C++ Documentation](https://img.shields.io/badge/documentation-c%2B%2B-blue)](https://first.wpi.edu/wpilib/allwpilib/docs/development/cpp/) -[![Java Documentation](https://img.shields.io/badge/documentation-java-orange)](https://first.wpi.edu/wpilib/allwpilib/docs/development/java/) +[![C++ Documentation](https://img.shields.io/badge/documentation-c%2B%2B-blue)](https://github.wpilib.org/allwpilib/docs/development/cpp/) +[![Java Documentation](https://img.shields.io/badge/documentation-java-orange)](https://github.wpilib.org/allwpilib/docs/development/java/) Welcome to the WPILib project. This repository contains the HAL, WPILibJ, and WPILibC projects. These are the core libraries for creating robot programs for the roboRIO. @@ -33,7 +33,7 @@ Below is a list of instructions that guide you through cloning, building, publis 1. Clone the repository with `git clone https://github.com/wpilibsuite/allwpilib.git` 2. Build the repository with `./gradlew build` or `./gradlew build --build-cache` if you have an internet connection 3. Publish the artifacts locally by running `./gradlew publish` -4. [Update your](OtherVersions.md) `build.gradle` [to use the artifacts](OtherVersions.md) +4. [Update your](DevelopmentBuilds.md) `build.gradle` [to use the artifacts](DevelopmentBuilds.md) # Building WPILib @@ -104,7 +104,7 @@ Run with `--build-cache` on the command-line to use the shared [build cache](htt ### Using Development Builds -Please read the documentation available [here](OtherVersions.md) +Please read the documentation available [here](DevelopmentBuilds.md) ### Custom toolchain location