stm32-rs / stm32f3xx-hal

A Rust embedded-hal HAL for all MCUs in the STM32 F3 family
https://crates.io/crates/stm32f3xx-hal
Apache License 2.0
164 stars 67 forks source link

Point external documentation to this crate / stm32-rs #48

Open dfrankland opened 4 years ago

dfrankland commented 4 years ago

We should likely update awesome-embedded-rust and also stm32f30x-hal to point to this crate since this crate is actively maintained. Related issue: https://github.com/japaric/stm32f30x-hal/issues/36

rubberduck203 commented 4 years ago

I created a PR on awesome-embedded-rust to address this. https://github.com/rust-embedded/awesome-embedded-rust/pull/236

rubberduck203 commented 4 years ago

This is done.

Sh3Rm4n commented 4 years ago

Should we wait to close this issue, until https://github.com/japaric/f3/pull/109 is merged?

cc @dfrankland

Sh3Rm4n commented 4 years ago

Thank you for taking action and submitting a PR to awesome-embedded-rust @rubberduck203 :+1:

rubberduck203 commented 4 years ago

@Sh3Rm4n I’m unsure what the PR on f3 has to do with this issue.

Sh3Rm4n commented 4 years ago

Yeah, you are right, this is not directly related to this issue. I'll let @dfrankland decide to close this issue :)

dfrankland commented 4 years ago

I think we are all good with the work @rubberduck203 put in for awesome-embedded-rust. Thank you!

Considering the amount of documentation that links to stm32f30x-hal I think it'll be good to get https://github.com/japaric/stm32f30x-hal/issues/36 closed as well. An example of this, is the The Embedded Rust Book, as of today, still points to stm32f30x (look under "Peripheral Access Crate (PAC)"): https://github.com/rust-embedded/book/blob/9f103c2a8aa91b959c7cddd31c950803d3ec06cc/src/start/registers.md. You can even check by Googling "stm32f30x" rust.

I think I'll make a checklist at the top and start checking some of the items off.

vringar commented 3 years ago

The outdated crate is also linked in the embedded-hal docs and should probably be replaced there as well.