Skip to content

Use platform/generator agnostic CMake commands #2539

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.

Sign up for GitHub

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 4 commits into from
Jul 14, 2025
Merged

Use platform/generator agnostic CMake commands #2539

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1ad7aa3
Use platform/generator agnostic CMake commands
will-v-pi Jun 23, 2025
b9c1426
review fixup
will-v-pi Jun 23, 2025
51c6ee6
Apply suggestions from code review
will-v-pi Jun 24, 2025
d347006
Whitespace fix
will-v-pi Jun 24, 2025
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
11 changes: 5 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,12 +177,11 @@ instructions for other platforms, and just in general, we recommend you see [Ras
1. Setup a CMake build directory.
For example, if not using an IDE:
```
$ mkdir build
$ cd build
$ cmake ..
```
$ cmake -S . -B build
```
> The cmake -S flag indicates the source directory, and -B tells cmake where to put the output files.

When building for a board other than the Raspberry Pi Pico, you should pass `-DPICO_BOARD=board_name` to the `cmake` command above, e.g. `cmake -DPICO_BOARD=pico2 ..` or `cmake -DPICO_BOARD=pico_w ..` to configure the SDK and build options accordingly for that particular board.
When building for a board other than the Raspberry Pi Pico, you should pass `-DPICO_BOARD=board_name` to the `cmake` command above, e.g. `cmake -S . -B build -DPICO_BOARD=pico2` or `cmake -S . -B build -DPICO_BOARD=pico_w` to configure the SDK and build options accordingly for that particular board.

Specifying `PICO_BOARD=<boardname>` sets up various compiler defines (e.g. default pin numbers for UART and other hardware) and in certain
cases also enables the use of additional libraries (e.g. wireless support when building for `PICO_BOARD=pico_w`) which cannot
Expand All @@ -193,7 +192,7 @@ instructions for other platforms, and just in general, we recommend you see [Ras

1. Make your target from the build directory you created.
```sh
$ make hello_world
$ cmake --build build --target hello_world
```

1. You now have `hello_world.elf` to load via a debugger, or `hello_world.uf2` that can be installed and run on your Raspberry Pi Pico-series device via drag and drop.
Expand Down
Loading