diff --git a/README.md b/README.md index 97b0067a73..c27ed5a089 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,7 @@ Welcome to the WPILib project. This repository contains the HAL, WPILibJ, and WP - [Custom toolchain location](#custom-toolchain-location) - [Formatting/Linting](#formattinglinting) - [CMake](#cmake) + - [Running examples in simulation](#running-examples-in-simulation) - [Publishing](#publishing) - [Structure and Organization](#structure-and-organization) - [Contributing to WPILib](#contributing-to-wpilib) @@ -131,6 +132,16 @@ If you only want to run the Java autoformatter, run `./gradlew spotlessApply`. CMake is also supported for building. See [README-CMAKE.md](README-CMAKE.md). +## Running examples in simulation + +Examples can be run in simulation with the following command: + +```bash +./gradlew wpilibcExamples:runExample +./gradlew wpilibjExamples:runExample +``` +where `Example` is the example's folder name. + ## Publishing If you are building to test with other dependencies or just want to export the build as a Maven-style dependency, simply run the `publish` task. This task will publish all available packages to ~/releases/maven/development. If you need to publish the project to a different repo, you can specify it with `-Prepo=repo_name`. Valid options are: