Propose adding firmware settings and changelog to README.md #16
Conversation
This file contains 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
aioue
approved these changes
Mar 25, 2023
|
Example of more Ember configuration parameters which values in that firmware that can sometimes be useful when troubleshooting:
|
Closed
|
@guozi7788 @iteadsw please could we merge? |
|
thanks you for submitting |
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.
@Daniel-zhan-itead in the spirit of openness and helping the community it would be great if you look at this proposed example and improve it to add more detailed firmware settings/configuration and changelog to README.md as requested by dev in #10
Please see these examples from some different but similar README.md files for community firmware build images as reference:
https://github.com/MattWestb/EFR32-FW/blob/main/Soff_EZSP/README.md
https://github.com/zha-ng/EZSP-Firmware/blob/master/Elelabs-ELU013/README.md
https://github.com/xsp1989/zigbeeFirmware/blob/master/firmware/Zigbee3.0_Dongle-NoSigned/EZSP/README.md
https://github.com/grobasoz/zigbee-firmware/blob/master/EFR32%20Series%202/EFR32MG21A020F1024/README.md
@Daniel-zhan-itead Also check out related discussions which have some questions about settings/configuration for Dongle-E:
grobasoz/zigbee-firmware#28
xsp1989/zigbeeFirmware#31
home-assistant/core#82004
PS: ZHA and Zigbee2MQTT developers need to know all these settings and more for troubleshooting in order to rule out stuff.