search

stm32-rs / stm32-eth

Embedded Ethernet driver in Rust
Apache License 2.0
150 stars 47 forks source link

Docs & Examples updates #56

Closed datdenkikniet closed 2 years ago

datdenkikniet commented 2 years ago

Add docs to everything and #[deny(missing_docs)]

Update the docs on how to run the examples.

Convert all examples to use defmt for logging.

Update the examples so all of them can run on all supported MCUs

Remove the arp-smoltcp example because it does the exact same thing as the arp example, but in a more roundabout manner that doesn't provide a neccessarily useful example. Using smoltcp in the presented manner is not very common.

Update the CI so that all examples are tested for one MCU for each family.

Add CHANGELOG.md.

Makes ieee802_3_miim an unconditional dependency

TODO:

datdenkikniet commented 2 years ago

I think this is as good as it is going to get for now. Haven't been able to actually test any of the rewritten examples yet. Once I get around to that (and it works, which is what I expect them to do), this will be merged