Repository navigation
Show how to use the library in README and list the ESP-IDF build's dependencies - #90
Merged
Merged
Conversation
…pendencies README gains a Usage Example: a host that plays a tone through a PersistenceProvider, a ServerListener, start(), open_input() and a write loop; a FetchContent snippet as tests/consumer/ consumes the library; and what an ESP-IDF project supplies to add the component. NOTICES.md lists the ESP-IDF build's registry components and ESP-IDF's own, and says micro-resampler's source is its vendored copy.
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The documentation matches the reviewed API and build configuration, with no unresolved findings.
0 open findings
What changed in this PR
Adds library integration guidance and completes ESP-IDF dependency notices, addressing #40.
Changes:
- Adds a C++ playback example and CMake consumption snippet.
- Expands ESP-IDF setup requirements and dependency licensing.
- Updates repository documentation descriptions.
| File | Description |
|---|---|
| README.md | Adds usage examples and ESP-IDF integration guidance. |
| NOTICES.md | Lists ESP-IDF dependencies and clarifies micro-resampler’s source. |
| CLAUDE.md | Updates documentation descriptions and ESP-IDF dependencies. |
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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
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.
Summary
README had no example of using the library and one line on ESP-IDF; NOTICES.md omitted the ESP-IDF build's dependencies and gave no source for micro-resampler.
Change
Usage Examplesection after Features, with:PersistenceProvider, aServerListener,start(),open_input()and a write loop onwrite()andwait_writable()Host (CMake): a FetchContent snippet, astests/consumer/consumes the libraryESP-IDF: the minimum ESP-IDF, the two ways to add the component (the root, or a wrapper astests/esp_idf/does), the dependencies and settings a project supplies, the embedded profile, no Opus and no mDNS backend. The Build section's ESP-IDF paragraph (the LWIP budgets) moves here.ESP-IDF buildtable (noise-c and libsodium from the esphome registry components, esp-dsp, ESP-IDF with FreeRTOS, mbedTLS, lwIP and esp_http_server) with sources and licenses. The micro-resampler entry says its vendored copy is the source, since it has no public upstream repository.start(), and a pointer to the pthread linker wraps (already indocs/internals.md).Tests
None added. The C++ snippet was compiled against the library through the CMake snippet's FetchContent form, but CI does not build it, so it can drift from the API. The ESP-IDF instructions were not tried in a fresh project.
Closes #40