search

m5stack / M5Unified

Unified library for M5Stack series
MIT License
276 stars 48 forks source link

Changed only documentation/comments -- describing the library in README for newcomers #97

Closed chipguyhere closed 5 months ago

chipguyhere commented 5 months ago

Hi M5Stack and the rest of the team working on this library --

I'm contributing this documentation because I think it's missing... I hear on forums from a lot of newcomers that they get lost trying to find documentation for the software for M5Stack, and this is meant to be a step in the right direction. I'm happy to contribute more, as I'm thinking of recommending M5Stack products at a local school to teach coding, but I know they will struggle if documentation is hard to find.

I might make contributions to code as well, such as adding examples, but I will keep this branch strictly limited to changes that have no effect on any existing code, so as to not have a testing burden.

lovyan03 commented 5 months ago

@chipguyhere I appreciate your pull request !

COZMIKDX commented 5 months ago

This is some nice stuff you've done here. Especially the M5Stack hardware functionality supported by the ESP32 ecosystem section explaining things you'd have to stumble around trying to figure out as a newcomer.