From dece2391f5d74b184c2e5756048c13d7879f7b1a Mon Sep 17 00:00:00 2001 From: Jade Date: Thu, 15 Aug 2024 00:24:50 +0800 Subject: [PATCH] [readme] Add note about building with Ninja in README-CMAKE (#6960) --- README-CMAKE.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README-CMAKE.md b/README-CMAKE.md index bb6c5e5c8d..33602cded9 100644 --- a/README-CMAKE.md +++ b/README-CMAKE.md @@ -77,12 +77,12 @@ The following build options are available: ## Build Setup -The WPILib CMake build does not allow in source builds. Because the `build` directory is used by Gradle, we recommend a `build-cmake` directory in the root. This folder is included in the gitignore. +The WPILib CMake build does not allow in source builds. Because the `build` directory is used by Gradle, we recommend a `build-cmake` directory in the root. This folder is included in the gitignore. We support building with Ninja; other options like Makefiles may be broken. Once you have a build folder, run CMake configuration in that build directory with the following command. ``` -cmake path/to/allwpilib/root +cmake path/to/allwpilib/root -G Ninja ``` If you want to change any of the options, add `-DOPTIONHERE=VALUE` to the `cmake` command. This will check for any dependencies. If everything works properly this will succeed. If not, please check out the troubleshooting section for help.