almindor / mipidsi

MIPI Display Serial Interface unified driver
MIT License
117 stars 46 forks source link

Add example on docs and /examples folder #66

Closed Slushee-a closed 1 year ago

Slushee-a commented 1 year ago

Why

As mentioned in #65, two improvements that could be made were adding another example project and expanding documentation on set_pixels()

Changes included

Slushee-a commented 1 year ago

Changes included on the latest commit:

Slushee-a commented 1 year ago

Changes included on the latest commit:

Slushee-a commented 1 year ago

I do agree with the fact that the fill_contiguous part of the example should be removed, since drawing basic shapes is already enough for the example.

Adding a link to the embedded-graphics examples is a great idea. Should it be added to the docs homepage or to the README?

rfuest commented 1 year ago

Adding a link to the embedded-graphics examples is a great idea. Should it be added to the docs homepage or to the README?

Both locations would make sense, some users might learn about the crate via the README while others read the docs first. The README already contains a reference to e-g with this sentence: "embedded-graphics-core is used to provide the drawing API.", but that isn't very useful for users of the crate IMO. The distinction between embedded-graphics-core and embedded-graphics should be considered an implementation detail and not something that is important for users. A short description what e-g is and links to the relevant docs would be more useful than a link to e-g-core.