Skip to content

docs(esp32 std demo): Add README.md for esp32-std-demo#171

Merged
orhun merged 8 commits intoratatui:mainfrom
Vaishnav-Sabari-Girish:docs/document_setup
Mar 20, 2026
Merged

docs(esp32 std demo): Add README.md for esp32-std-demo#171
orhun merged 8 commits intoratatui:mainfrom
Vaishnav-Sabari-Girish:docs/document_setup

Conversation

@Vaishnav-Sabari-Girish
Copy link
Copy Markdown
Contributor

The documentation for the ESP32 std demo has been added.

The documentation for the ESP32 `std` demo has been added.

Signed-off-by: Vaishnav Sabari Girish <vaishnav.sabari.girish@gmail.com>
Copy link
Copy Markdown
Member

@j-g00da j-g00da left a comment

Choose a reason for hiding this comment

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

This includes much more than needed, while skipping what is actually important - e.g. how battery voltage reader is wired (it uses a voltage divider, it's described in the code*) so that someone can replicate the same circuit with different/custom board.

All three:

  • driver
  • screen offset
  • screen size

are specific to the specific screen used in T-display and should be adjusted if using different one.

This PR looks AI generated...

EDIT: * I think I mixed it up with a different project; anyway the t-display pcb schematics are available online, it uses a voltage divider that halves the battery voltage before the ADC, that's why it's multiplied *2 in the code.

@Vaishnav-Sabari-Girish
Copy link
Copy Markdown
Contributor Author

Understood @j-g00da ,
I'll add the changes you requested. Thank you fornthe honest review @orhun and @j-g00da .

@orhun orhun marked this pull request as draft February 22, 2026 09:55
This commit adds the improvements as requested.

Signed-off-by: Vaishnav Sabari Girish <vaishnav.sabari.girish@gmail.com>
@Vaishnav-Sabari-Girish
Copy link
Copy Markdown
Contributor Author

Hey @orhun , @j-g00da
I have updated the README.md as requested. Please let me know if any more improvements are required

@orhun orhun marked this pull request as ready for review March 5, 2026 11:22
@orhun orhun requested review from j-g00da and orhun March 5, 2026 11:22
Copy link
Copy Markdown
Member

@orhun orhun left a comment

Choose a reason for hiding this comment

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

I updated the style a bit. This should be alright to go.

@orhun
Copy link
Copy Markdown
Member

orhun commented Mar 6, 2026

Can you revert the changes to 86ae685 ? With your last force-push the style changes are reverted.

@Vaishnav-Sabari-Girish
Copy link
Copy Markdown
Contributor Author

Can you revert the changes to 86ae685 ? With your last force-push the style changes are reverted.

I am unable to revert the changes @orhun . I am not able to find that specific commit in my commit history or even after I fetch.

Please let me know what else I can do.

@orhun orhun force-pushed the docs/document_setup branch from a902840 to 86ae685 Compare March 7, 2026 19:02
@orhun
Copy link
Copy Markdown
Member

orhun commented Mar 7, 2026

I force pushed again

@Vaishnav-Sabari-Girish
Copy link
Copy Markdown
Contributor Author

I force pushed again

Will look into it @orhun

@orhun
Copy link
Copy Markdown
Member

orhun commented Mar 8, 2026

Nothing needs to be done here. Please don't overwrite the history again :)

@orhun orhun merged commit 874c59a into ratatui:main Mar 20, 2026
27 checks passed
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.

3 participants