mipidsi icon indicating copy to clipboard operation
mipidsi copied to clipboard

Improve readme example code

Open alyti opened this issue 2 years ago • 2 comments

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.

alyti avatar Jan 20 '23 15:01 alyti

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 avatar Jan 21 '23 03:01 almindor

  • 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

almindor avatar Jan 23 '23 17:01 almindor