doc update #3437
Open
doc update #3437
+136
−1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…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 <[email protected]>
- 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 <[email protected]>
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
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 <[email protected]>
Contributor
Author
HiFiPhile
approved these changes
Dec 28, 2025
Contributor
There was a problem hiding this comment.
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.
HiFiPhile
changed the title
Signed-off-by: Zixun LI <[email protected]>
Size Difference ReportBecause TinyUSB code size varies by port and configuration, the metrics below represent the averaged totals across all example builds. Note: If there is no change, only one value is shown. Changes >1% in sizeNo entries. Changes <1% in sizeNo entries. No changes
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Describe the PR
Added comprehensive build instructions for RP2040 and ESP32 platforms with required SDK installation and environment setup steps before cmake.
Update comment on CDC EP size
fix #3287