General usage documentation issues

Open
#516 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
c, cmake, cpp
Domain
build-system, documentation, embedded-iot

Research direction

Start by comparing the README with the C/C++ SDK manual PDF, then inspect the CMake toolchain messages and freertos/FreeRTOS_Kernel_import.cmake. Check the documented setup for PICO_RISCV_TOOLCHAIN_PATH, PICO_ARM_TOOLCHAIN_PATH, the TinyUSB Pico-PIO-USB submodule, and the rp2350-arm-s port. Done means the documentation gives consistent, actionable answers for each setup issue.

Written by the indexing model from the issue text.

Description

I just got a SparkFun Pro RP2350 and I'm trying to get the examples to build. I've run into a few issues I could fix via web search, but there are some outstanding ones:

  1. RISC-V compilers: The README says to use stable but the C/C++ SDK manual PDF says to use top-of-tree. Who's right? Will both of them work?
  2. The CMake step says: Skipping universal examples as PICO_RISCV_TOOLCHAIN_PATH and PICO_ARM_TOOLCHAIN_PATH are not defined. Where is the documentation on how to set these?
  3. CMake: Skipping TinyUSB dual examples, as TinyUSB hw/mcu/raspberry_pi/Pico-PIO-USB submodule unavailable. How do I get that submodule?
  4. FreeRtOS:
Using FREERTOS_KERNEL_PATH from environment ('/var/home/znmeb/dbx-homes/CLAMS-PicoSDK/pico/FreeRTOS-Kernel')
CMake Error at freertos/FreeRTOS_Kernel_import.cmake:87 (message):
  Directory '/var/home/znmeb/dbx-homes/CLAMS-PicoSDK/pico/FreeRTOS-Kernel'
  does not contain a 'rp2350-arm-s' port here:
  portable/ThirdParty/Community-Supported-Ports/GCC/RP2350_ARM_NTZ

How do I get the rp2350-arm-s port? A web search didn't turn anything up, so I assume either it hasn't been released yet or the search engines haven't indexed it.

Dominant language
C
Stars
3.9k
Forks
1k
Avg merge
1d 16h
Merged PRs (30d)
1

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from raspberrypi/pico-examples

All issues in raspberrypi/pico-examples

Similar issues

More C issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.