Skip to content
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

Remove 'pre-release' from README and add some additional detail for platform/board #547

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Remove 'pre-release' from README and add some additional detail for platform/board #547

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
26 changes: 12 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,21 @@
# Raspberry Pi RP2350 Pico SDK Examples - Early Access

## RP2350 Instructions

Everything below this section is from the stock pico-examples, so ignore URLs etc., but generally instructions are the same.

The Pico SDK default continues to be to build for RP2040 (PICO_PLATFORM=rp2040), so to build for RP2350, you need to pass
`-DPICO_PLATFORM=rp2350` to CMake (or `-DPICO_PLATFORM=rp2350-riscv` for RISC-V).

Most, but not all examples, currently work on RP2350 however you should be able to do a full build with any of the above platforms (PICO_PLATFORM=host however currently fails on some examples)

For RISC-V compilation, you should take a compiler from here: https://www.embecosm.com/resources/tool-chain-downloads/#riscv-stable

# Original pico-examples docs
# Raspberry Pi Pico SDK Examples

## Getting started

See [Getting Started with the Raspberry Pi Pico](https://rptl.io/pico-get-started) and the README in the [pico-sdk](https://github.com/raspberrypi/pico-sdk) for information
on getting up and running.

##### 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.
Equally, for instance, Wi-Fi and Bluetooth examples will only build on a board that includes Wi-Fi and Bluetooth support.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

chip-specific should probably be hyphenated?


Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor tweak, but I think I'd replace "Equally, for instance, " with just "Similarly, " ?

Board and platform information are passed to the CMake build via the `PICO_PLATFORM` and `PICO_BOARD` variables.
For more information see the "Platform and Board Configuration" chapter of
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

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.
### First Examples
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should probably be a blank line between this line and the next header.


App| Description | Link to prebuilt UF2
Expand Down
Loading