Skip to content

Commit 6cf0398

Browse files
authored
Update README.md
@kilograham A few proposed changes to the readme: - Remove some early access copy - Call out which examples are RP235x only - Fix link the HSTX example Could you review the first paragraph of build instructions too?
1 parent 7fe60d6 commit 6cf0398

File tree

1 file changed

+8
-13
lines changed

1 file changed

+8
-13
lines changed

README.md

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
1-
# Raspberry Pi RP2350 Pico SDK Examples - Early Access
2-
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.
1+
# Raspberry Pi Pico SDK Examples
62

73
The Pico SDK default continues to be to build for RP2040 (PICO_PLATFORM=rp2040), so to build for RP2350, you need to pass
84
`-DPICO_PLATFORM=rp2350` to CMake (or `-DPICO_PLATFORM=rp2350-riscv` for RISC-V).
@@ -11,7 +7,6 @@ Most, but not all examples, currently work on RP2350 however you should be able
117

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

14-
# Original pico-examples docs
1510

1611
## Getting started
1712

@@ -40,7 +35,7 @@ App|Description
4035
[dma_capture](adc/dma_capture) | Use the DMA to capture many samples from the ADC.
4136
[read_vsys](adc/read_vsys) | Demonstrates how to read VSYS to get the voltage of the power supply.
4237

43-
### Bootloaders (RP2350 Only)
38+
### Bootloaders (RP235x Only)
4439
App|Description
4540
---|---
4641
[enc_bootloader](bootloaders/encrypted) | A bootloader which decrypts binaries from flash into SRAM. See the separate [README](bootloaders/encrypted/README.md) for more information
@@ -60,7 +55,7 @@ App|Description
6055
---|---
6156
[build_variants](cmake/build_variants) | Builds two version of the same app with different configurations
6257

63-
### DCP
58+
### DCP (RP235x Only)
6459

6560
App|Description
6661
---|---
@@ -75,11 +70,11 @@ App|Description
7570
[channel_irq](dma/channel_irq) | Use an IRQ handler to reconfigure a DMA channel, in order to continuously drive data through a PIO state machine.
7671
[sniff_crc](dma/sniff_crc) | Use the DMA engine's 'sniff' capability to calculate a CRC32 on a data buffer.
7772

78-
### HSTX
73+
### HSTX (RP235x Only)
7974

8075
App|Description
8176
---|---
82-
[dvi_out_hstx_encoder](dvi_out_hstx_encoder) `RP2350`| Use the HSTX to output a DVI signal with 3:3:2 RGB
77+
[dvi_out_hstx_encoder](hstx/dvi_out_hstx_encoder) | Use the HSTX to output a DVI signal with 3:3:2 RGB
8378

8479
### Flash
8580

@@ -149,11 +144,11 @@ App|Description
149144
[multicore_runner](multicore/multicore_runner) | Set up the second core to accept, and run, any function pointer pushed into its mailbox FIFO. Push in a few pieces of code and get answers back.
150145
[multicore_doorbell](multicore/multicore_doorbell) | Claims two doorbells for signaling between the cores. Counts how many doorbell IRQs occur on the second core and uses doorbells to coordinate exit.
151146

152-
### OTP
147+
### OTP (RP235x Only)
153148

154149
App|Description
155150
---|---
156-
[hello_otp](otp/hello_otp) | Demonstrate reading and writing from the OTP on RP2350, along with some of the features of OTP (error correction and page locking).
151+
[hello_otp](otp/hello_otp) | Demonstrate reading and writing from the OTP on RP235x, along with some of the features of OTP (error correction and page locking).
157152

158153
### Pico Board
159154

@@ -316,7 +311,7 @@ App|Description
316311
[rtc_alarm](rtc/rtc_alarm) | Set an alarm on the RTC to trigger an interrupt at a date/time 5 seconds into the future.
317312
[rtc_alarm_repeat](rtc/rtc_alarm_repeat) | Trigger an RTC interrupt once per minute.
318313

319-
### SHA-256
314+
### SHA-256 (RP235x Only)
320315

321316
App|Description
322317
---|---

0 commit comments

Comments
 (0)