diff --git a/tools/cmake/README.md b/tools/cmake/README.md index c7db5bc9e5..9b02e14721 100644 --- a/tools/cmake/README.md +++ b/tools/cmake/README.md @@ -43,23 +43,27 @@ Supported examples can be identified by the presence of a top level `CMakelists. Prerequisities: - CMake >=3.19.0 -- mbed-tools >=3.4.0 +- mbed-tools >=3.5.0 -From the application root or wherever `mbed-os.lib` is found: -1. Run the following command to create the Mbed OS configuration CMake module: +From the application root or wherever `mbed-os.lib` is found, run the following command to: + * create the Mbed OS configuration CMake module + * create a build directory + * generate the project configuration + * build the project using the `Ninja` build system ``` - mbedtools configure -m -t + mbedtools build -m -t ``` -1. Run the following command to create a build directory, generate the project configuration and build the project using `Ninja`: +`CMAKE_BUILD_TYPE` can overridden with Mbed specific values: `Develop` (default value), `Release` and `Debug`. - ``` - mkdir build && cd build && cmake .. -GNinja && cmake --build . - ``` - -The default build type is `Develop`. Use `CMAKE_BUILD_TYPE` to select `Develop`, `Release` or `Debug` as follows: +`mbed-tools` will pass `-DCMAKE_BUILD_TYPE=` for you when using the `--build-type` optional argument of the `build` subcommand as follows: ``` -cmake .. -GNinja -DCMAKE_BUILD_TYPE= && cmake --build . +mbedtools build -m -t -b +``` + +If you're running CMake directly, you may need to pass it in yourself as follows: +``` +cmake -S -B -DCMAKE_BUILD_TYPE=debug ```