Remove 'pre-release' from README and add some additional detail for platform/board #547
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lurch
reviewed
Sep 11, 2024
| ##### Notes on different boards and platforms (RP2040 / RP2350) | ||
|
|
||
| The majority of examples are applicable to both RP2040 and RP2350 based boards, | ||
| however certain examples that use chip specific functionality will only build on that platform. |
There was a problem hiding this comment.
chip-specific should probably be hyphenated?
lurch
reviewed
Sep 11, 2024
|
|
||
| The majority of examples are applicable to both RP2040 and RP2350 based boards, | ||
| however certain examples that use chip specific functionality will only build on that platform. | ||
| Equally, for instance, Wi-Fi and Bluetooth examples will only build on a board that includes Wi-Fi and Bluetooth support. |
There was a problem hiding this comment.
Minor tweak, but I think I'd replace "Equally, for instance, " with just "Similarly, " ?
lurch
reviewed
Sep 11, 2024
| however certain examples that use chip specific functionality will only build on that platform. | ||
| Equally, for instance, Wi-Fi and Bluetooth examples will only build on a board that includes Wi-Fi and Bluetooth support. | ||
|
|
||
| Board and platform information are passed to the CMake build via the `PICO_PLATFORM` and `PICO_BOARD` variables. |
There was a problem hiding this comment.
Could swap around "Board and platform information" to "Platform and board information", as that then matches the "Platform and Board Configuration" chapter-name in the SDK book 🙂 (and you already mention PICO_PLATFORM and PICO_BOARD in that order too)
lurch
reviewed
Sep 11, 2024
| For more information see the "Platform and Board Configuration" chapter of | ||
| the [Raspberry Pi Pico-series C/C++ SDK](https://rptl.io/pico-c-sdk) book | ||
|
|
||
| Information on which examples are not being built is output during the CMake configuration step. |
There was a problem hiding this comment.
Should probably be a blank line between this line and the next header.
|
Do you want to pick up the other fixes (e.g. the HSTX link) from #519 too? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.