Skip to content

Update README.md #130

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 23, 2024
Merged

Update README.md #130

merged 1 commit into from
Sep 23, 2024

Conversation

MitchBradley
Copy link
Contributor

This is an attempt to align the instructions with current build usage.

  • Clarified the new behavior of clean, submodules, and mpy_cross and fixed the example build lines with respect to their use
  • For embedded Python code examples, used the markdown code inclusion syntax so the code is syntax-highlighted and does not have excess indentation.
  • Mentioned the rgb_display driver as an adjunct to the hardcoded drivers.

* Clarified the new behavior of clean, submodules, and mpy_cross and fixed the example build lines with respect to their use
* For embedded Python code examples, used the markdown code inclusion syntax so the code is syntax-highlighted and does not have excess indentation.
* Mentioned the rgb_display driver as an adjunct to the hardcoded drivers.
@jd3096-mpy
Copy link

This is an attempt to align the instructions with current build usage.

  • Clarified the new behavior of clean, submodules, and mpy_cross and fixed the example build lines with respect to their use
  • For embedded Python code examples, used the markdown code inclusion syntax so the code is syntax-highlighted and does not have excess indentation.
  • Mentioned the rgb_display driver as an adjunct to the hardcoded drivers.

Yes, I've always thought that the README of this repository is somewhat inaccurate and not up to date, possibly because the author updates it frequently. At the same time, I also believe there should be an 'examples' folder to store some simple demos. Otherwise, it can be quite challenging for beginners to correctly initialize the hardware.

@MitchBradley
Copy link
Contributor Author

I also believe there should be an 'examples' folder to store some simple demos.

Seems like a good idea. I suspect that if you were to volunteer to be the curator of same, the help would be appreciated. For starters, there is an example rgb driver at the end of #128

@kdschlosser
Copy link
Collaborator

the intended lines actually had a purpose. It was done to make converting from markdown to ReST easier to do when I put together a documentation build system which is going to use Sphinx. Not a deal breaker or anything like that but there was a reason why I had indented the code block like they were.

@kdschlosser
Copy link
Collaborator

I also created a discussion board so users could add their display startup code for specific boards they are using.

@kdschlosser kdschlosser merged commit f329c46 into lvgl-micropython:main Sep 23, 2024
1 of 3 checks passed
@MitchBradley MitchBradley deleted the patch-1 branch September 23, 2024 07:31
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