Skip to content
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

Improve readme example code #51

Open
alyti opened this issue Jan 20, 2023 · 2 comments
Open

Improve readme example code #51

alyti opened this issue Jan 20, 2023 · 2 comments
Assignees
Labels
enhancement New feature or request

Comments

@alyti
Copy link

alyti commented Jan 20, 2023

Based on this article that covered use of this library the following changes from it's summary could be applied to the current readme:

  • mipidsi documentation should include required use statements in its example code, as well as linking out to required crates
  • mipidsi documentation should not reference the no-longer-used Rgb666 color type

These changes would improve beginner journey.

@almindor almindor self-assigned this Jan 21, 2023
@almindor almindor added the enhancement New feature or request label Jan 21, 2023
@almindor
Copy link
Owner

I can have a look, one problem is that a "real" example case would need to use some sort of specific embedded-hal implementation to get the SPI for example. That would bring a whole tree of dependencies in, and would be generally useless as an example because it'd only work for people with that setup anyhow.

@almindor
Copy link
Owner

  • mipidsi documentation should not reference the no-longer-used Rgb666 color type

What do you mean with this exactly? Rgb666 is a valid color, it's just RawU18 that will go away AFAIK

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants