Adding code examples to the documentation

[armandas]

I'm thinking to make documentation more useful and accessible by adding code examples. Would you be happy to accept this?

To start with, I would add just a basic example to the documentation of each module, like in the standard library documentation: https://doc.rust-lang.org/std/vec/index.html

Example:

I would also like to make one PR per crate or possibly per module. What to you think?

---

To do

• [x] atmega-hal: https://github.com/Rahix/avr-hal/pull/591
• [x] attiny-hal: https://github.com/Rahix/avr-hal/pull/592
• [ ] arduino-hal

[Rahix]

Yes please, the documentation is still quite lacking at the moment. I think it may also be a good idea to link to relevant example programs from the docs. I think working through this per-crate is fine, it that works for you.