stm32f3xx-hal icon indicating copy to clipboard operation
stm32f3xx-hal copied to clipboard

Point external documentation to this crate / stm32-rs

Open dfrankland opened this issue 5 years ago • 8 comments

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

dfrankland avatar Jan 01 '20 21:01 dfrankland

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

rubberduck203 avatar Jan 04 '20 13:01 rubberduck203

This is done.

rubberduck203 avatar Jan 04 '20 15:01 rubberduck203

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

cc @dfrankland

Sh3Rm4n avatar Jan 04 '20 18:01 Sh3Rm4n

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

Sh3Rm4n avatar Jan 04 '20 18:01 Sh3Rm4n

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

rubberduck203 avatar Jan 05 '20 11:01 rubberduck203

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

Sh3Rm4n avatar Jan 05 '20 12:01 Sh3Rm4n

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.

dfrankland avatar Jan 06 '20 04:01 dfrankland

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

vringar avatar Jun 13 '21 16:06 vringar