Skip to content

CMake: Specify mbedtools in the build instructions #13887

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 14 additions & 10 deletions tools/cmake/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <mbed-target> -t <toolchain>
mbedtools build -m <mbed-target> -t <toolchain>
```

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 .
```
`mbed-tools` will pass `-DCMAKE_BUILD_TYPE=<supported-build-type>` for you when using the `--build-type` optional argument of the `build` subcommand as follows:

The default build type is `Develop`. Use `CMAKE_BUILD_TYPE` to select `Develop`, `Release` or `Debug` as follows:
```
mbedtools build -m <mbed-target> -t <toolchain> -b <supported-build-type>
```

If you're running CMake directly, you may need to pass it in yourself as follows:
```
cmake .. -GNinja -DCMAKE_BUILD_TYPE=<supported-build-type> && cmake --build .
cmake -S <source-dir> -B <build-dir> -DCMAKE_BUILD_TYPE=debug
```