Update README #1251
Merged
Update README #1251
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
Cmdmac
pushed a commit
to Cmdmac/xiaozhi-esp32
that referenced
this pull request
Oct 14, 2025
* Upgrade to the latest ml307 component * update README
Wvirgil123
added a commit
to Wvirgil123/xiaozhi-esp32
that referenced
this pull request
Oct 20, 2025
* main: Add 16 more languages to locales (78#1297) Fix LilyGo-T-CameraPlus-S3 Camera (78#1295) Fix lichuang-dev camera (78#1290) 将太极派新款和旧款分离 (78#1287) Refactor: Use esp_video component (78#1245) add support for Wireless-Tag WTP4C5MP07S ESP32P4 board + 7 inch MIPI DSI LCD display combo (78#1281) Optimize AdcBatteryMonitor to work without charge detection pin. (78#1276) enable rrti for m5stack-tab5 (78#1268) Add LILYGO T-Display-P4 board adaptation (78#1269) Added Waveshare ESP32-P4-WIFI6-Touch-LCD-7B third party board (78#1243) Add esp32c5 configuration (78#1258) Change the button array to ADC buttons as in the board for esp32s3-korv2 (78#1256) Add SetInputGain(float gain) to AudioCodec (78#1252) Update README (78#1251)
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.
This pull request focuses on improving documentation, especially for custom board development and multi-language support, and clarifies configuration options for various hardware platforms. It also removes some redundant compile flags configuration. The most significant changes are detailed below:
Documentation Improvements and Restructuring:
README.md,README_en.md, andREADME_ja.mdfiles to provide clearer project introductions, versioning notes, and a new "About the Project" section. These updates also add information about client projects and tools, and clarify hardware compatibility and upgrade instructions. [1] [2] [3] [4] [5] [6]main/boards/README.mdtodocs/custom-board.md, and its content has been significantly expanded. The guide now includes step-by-step instructions for directory naming,config.jsonoptions, build system integration (Kconfig, CMake), and both manual and automated build processes. [1] [2] [3]Hardware Platform and Build Configuration:
main/boards/esp-box-3/README.md, detailing hardware features, configuration, UI style selection, and usage instructions for the ESP-BOX-3 platform.Configuration and Compatibility Updates:
docs/custom-board.mdlocation and added missing protocol documentation links. [1] [2] [3]config.jsonfiles, removing redundant or now-automated configuration keys (e.g.,CONFIG_BOARD_TYPE_*). [1] [2] [3]Feature Highlights:
Other:
CompileFlagssection from.clangd, cleaning up unused compile flag removal configuration.