Skip to content

reivew of README content#73

Open
bestbug456 wants to merge 6 commits into
luar123:v2from
bestbug456:master
Open

reivew of README content#73
bestbug456 wants to merge 6 commits into
luar123:v2from
bestbug456:master

Conversation

@bestbug456
Copy link
Copy Markdown

Hello!

I was looking for something for using ESP Home with zigbee, I found out this repository which was kinda easy to include and build with it, but it was kinda of a exploration of the readme and the example. I'd like to submit a pull request to enhance the readability of the README while preserving all the original information (to the best of my understanding).

Before proceeding, I have a few questions to ensure the changes align with the project's goals:

  • CSV File Requirement: The example mentions a CSV file, but it's unclear whether it's a required file or an optional optimization. Could you clarify if this file is necessary for the build process or if it's just an optional step for specific use cases?
  • Limitations I’m not entirely certain if all the listed limitations are still applicable. Could you confirm if the current list is up-to-date or if any details need updating?

Thank you for your excellent work on this project! I was also curious—did you consider submitting a feature proposal to the original ESP Home project for Zigbee integration?
Cheers

@luar123
Copy link
Copy Markdown
Owner

luar123 commented Dec 5, 2025

Thanks, readme could always be improved.
I will probably need some time for a detailed review, but to answer your questions:

The example mentions a CSV file, but it's unclear whether it's a required file or an optional optimization. Could you clarify if this file is necessary for the build process or if it's just an optional step for specific use cases?

The partitions.csv is needed. You will get a validation error if it is not correct.

Limitations I’m not entirely certain if all the listed limitations are still applicable. Could you confirm if the current list is up-to-date or if any details need updating?

I think it is up-to-date.

Please remove the batches on top, two are useless anyway and the 3rd is not really helping.

Removed GitHub badges from README and added important documentation about the mandatory partitions_zb.csv file that must be included in ESP32 configurations when using this component. The new section explains that this file is required for proper Zigbee operations and can be found in the component directory, defining the memory partitions needed for Zigbee functionality.
@bestbug456
Copy link
Copy Markdown
Author

Thanks! I've updated removing the badges and referring to the csv file! Let me know if you find anything else that can be improved!

Copy link
Copy Markdown
Owner

@luar123 luar123 left a comment

Choose a reason for hiding this comment

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

Overall looks nice, just some information got lost. Can you include the missing pieces?

Comment thread README.md Outdated
Comment thread README.md Outdated
@luar123 luar123 changed the base branch from master to v2 May 30, 2026 15:43
@luar123
Copy link
Copy Markdown
Owner

luar123 commented May 30, 2026

I think overall this looks fine.
I changed the base branch to v2, because v2 will be merged into master soon. Please resolve conflicts and make sure to keep the recent changes (mostly from #85). Also the partition table is not needed anymore.

bestbug456 and others added 3 commits June 2, 2026 12:56
… remove partition table note

- Reorganized README with table of contents
- Formatted features, limitations, and configuration sections
- Removed partition table requirement (no longer needed)
- Kept all recent changes from luar123#85
@bestbug456
Copy link
Copy Markdown
Author

I think overall this looks fine. I changed the base branch to v2, because v2 will be merged into master soon. Please resolve conflicts and make sure to keep the recent changes (mostly from #85). Also the partition table is not needed anymore.

Done, let me know if you need any more changes. Thanks!

@luar123
Copy link
Copy Markdown
Owner

luar123 commented Jun 2, 2026

Please double check, there seem to be a few mix-ups: Changes from #98 and #85 are reverted and it seems that some parts are duplicated. Also please make sure to keep the - for lists instead of *.

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.

2 participants