Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Dec 28, 2025

Describe the PR

Added comprehensive build instructions for RP2040 and ESP32 platforms with required SDK installation and environment setup steps before cmake.

  • RP2040 section: Pico SDK installation (Linux/macOS/Windows), PICO_SDK_PATH export steps, and build example
  • ESP32 section: ESP-IDF installation (Linux/macOS/Windows), environment sourcing (export.sh/export.bat/export.ps1), and build example
  • Platform-specific syntax: bash for Linux/macOS, bat for Command Prompt, powershell for PowerShell
  • Cross-references: Updated initial note to link to new detailed sections

fix #3287

Additional context

Both sections follow the same structure: SDK installation → environment setup → build example, with tips for persistent configuration.

Original prompt

On getting_started.rst, Improve build step for rp2040 and esp32 by adding additional steps:

  • rp2040: install pick-sdk; export sdk path to PICO_SDK_PATH before cmake
  • esp32 : install esp-idf; source esp-idf (export.bat or export.sh) before cmake

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI and others added 2 commits December 28, 2025 14:18
…ed.rst

- Added dedicated "Building for RP2040" section with pico-sdk installation steps
- Added dedicated "Building for ESP32" section with esp-idf installation steps
- Included platform-specific instructions for Linux/macOS and Windows
- Added PICO_SDK_PATH export steps before cmake for rp2040
- Added esp-idf source/export steps before cmake for esp32
- Updated note section to reference new detailed sections
- Documentation builds successfully without errors

Co-authored-by: HiFiPhile <4375114+HiFiPhile@users.noreply.github.com>
- Changed Windows Command Prompt blocks from bash to bat for proper highlighting
- Changed PowerShell blocks from bash to powershell for proper highlighting
- Improves documentation readability and accuracy

Co-authored-by: HiFiPhile <4375114+HiFiPhile@users.noreply.github.com>
Copilot AI changed the title [WIP] Improve build steps for rp2040 and esp32 Add detailed SDK setup instructions for RP2040 and ESP32 builds Dec 28, 2025
Copilot AI requested a review from HiFiPhile December 28, 2025 14:21
@HiFiPhile
Copy link
Collaborator

@copilot fix precommit check error

- Removed trailing whitespace from line 37 as detected by pre-commit check
- Documentation builds successfully

Co-authored-by: HiFiPhile <4375114+HiFiPhile@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Dec 28, 2025

@copilot fix precommit check error

Fixed in db08f5f - removed trailing whitespace from line 37 in getting_started.rst

@HiFiPhile HiFiPhile marked this pull request as ready for review December 28, 2025 14:27
Copilot AI review requested due to automatic review settings December 28, 2025 14:27
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR adds comprehensive SDK setup instructions for building TinyUSB on RP2040 and ESP32 platforms, addressing a gap in the existing documentation that previously only mentioned SDK requirements without detailed installation steps.

Key changes:

  • Added detailed "Building for RP2040" section with Pico SDK installation, environment setup, and build example
  • Added detailed "Building for ESP32" section with ESP-IDF installation, environment sourcing, and build example
  • Updated initial note to include cross-references to the new detailed sections

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

esp32s3: tools/get_deps and make BOARD=xxx get-deps fails

2 participants