Skip to content

Commit ad7be28

Browse files
committed
CMake: Specify mbedtools in the build instructions
mbedtools provides a more user friendly UX for building application.
1 parent 22d926f commit ad7be28

File tree

1 file changed

+8
-11
lines changed

1 file changed

+8
-11
lines changed

tools/cmake/README.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -45,21 +45,18 @@ Prerequisities:
4545
- CMake >=3.19.0
4646
- mbed-tools >=3.4.0
4747

48-
From the application root or wherever `mbed-os.lib` is found:
49-
1. Run the following command to create the Mbed OS configuration CMake module:
48+
From the application root or wherever `mbed-os.lib` is found, run the following command to:
49+
* create the Mbed OS configuration CMake module
50+
* create a build directory
51+
* generate the project configuration
52+
* build the project using the `Ninja` build system
5053

5154
```
52-
mbedtools configure -m <mbed-target> -t <toolchain>
55+
mbedtools build -m <mbed-target> -t <toolchain>
5356
```
5457
55-
1. Run the following command to create a build directory, generate the project configuration and build the project using `Ninja`:
56-
57-
```
58-
mkdir build && cd build && cmake .. -GNinja && cmake --build .
59-
```
60-
61-
The default build type is `Develop`. Use `CMAKE_BUILD_TYPE` to select `Develop`, `Release` or `Debug` as follows:
58+
The default build type is `Develop`. Use the `--build-type` optional argument of the `build` subcommand to select `Develop`, `Release` or `Debug` as follows:
6259
6360
```
64-
cmake .. -GNinja -DCMAKE_BUILD_TYPE=<supported-build-type> && cmake --build .
61+
mbedtools build -m <mbed-target> -t <toolchain> -b <supported-build-type>
6562
```

0 commit comments

Comments
 (0)