Skip to content

Commit c8befdf

Browse files
authored
Remove 'pre-release' from README and add some additional detail for platform/board (#547)
1 parent b87dabf commit c8befdf

File tree

1 file changed

+12
-13
lines changed

1 file changed

+12
-13
lines changed

README.md

+12-13
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,21 @@
1-
# Raspberry Pi RP2350 Pico SDK Examples - Early Access
1+
# Raspberry Pi Pico SDK Examples
22

3-
## RP2350 Instructions
4-
5-
Everything below this section is from the stock pico-examples, so ignore URLs etc., but generally instructions are the same.
6-
7-
The Pico SDK default continues to be to build for RP2040 (PICO_PLATFORM=rp2040), so to build for RP2350, you need to pass
8-
`-DPICO_PLATFORM=rp2350` to CMake (or `-DPICO_PLATFORM=rp2350-riscv` for RISC-V).
3+
## Getting started
94

10-
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)
5+
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
6+
on getting up and running.
117

12-
For RISC-V compilation, you should take a compiler from here: https://www.embecosm.com/resources/tool-chain-downloads/#riscv-stable
8+
##### Notes on different boards and platforms (RP2040 / RP2350)
139

14-
# Original pico-examples docs
10+
The majority of examples are applicable to both RP2040 and RP2350 based boards,
11+
however certain examples that use chip-specific functionality will only build on that platform.
12+
Similarly, Wi-Fi and Bluetooth examples will only build on a board that includes Wi-Fi and Bluetooth support.
1513

16-
## Getting started
14+
Platform and board information are passed to the CMake build via the `PICO_PLATFORM` and `PICO_BOARD` variables.
15+
For more information see the "Platform and Board Configuration" chapter of
16+
the [Raspberry Pi Pico-series C/C++ SDK](https://rptl.io/pico-c-sdk) book
1717

18-
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
19-
on getting up and running.
18+
Information on which examples are not being built is output during the CMake configuration step.
2019

2120
### First Examples
2221

0 commit comments

Comments
 (0)