Improve README #119
Merged
Improve README #119
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This improves readability in text mode.
|
The Readme is long overdue for an update. The improvements you've made in this PR look good. I just want to make sure we capture the issues with flashing the L0 family MCU's with OpenOCD v.0.10.0. I'll look into adding the instructions (removed in this PR) to the Embedded Rust book as the flashing issue can be frustratingly difficult to track down (and it doesn't seem OpenOCD is planning to release the fixed version any time soon). That said, I'm going to merge this PR. Thanks! |
|
Great, thanks for the quick review @arkorobotics 🙂 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A lot of people had troubles with using this HAL because the Cargo features were not set up properly. For example:
stm32l0xx_hal::pac::I2C1#118These features were inadequately documented. The first commit of this PR attempts to fix that by documenting how to properly specify a dependency on
stm32l0xx-hal(and the available Cargo features).Additionally, I simplified the toolchain setup docs. The repo still contains helper scripts for flashing and debugging. These scripts are highly dependent on your debug probe (JLink? STLink? Something else?), your toolchain (OpenOCD? JLinkExe? The STLink tool? Cargo Flash?), your OS and your MCU. I do not think they should belong in this repo. Documentation on different setups should probably be moved to the Embedded Rust book. My suggestion would be to remove the helper scripts and the corresponding sections in the README (the README updated by this PR already contains a link to the Embedded Rust book).
If there's a toolchain we should recommend, then in my opinion it should be cargo-flash or cargo-embed (as soon as GDB debugging works reliably). Shoutout to @Yatekii @Tiwalun @adamgreig and many others that are working on the probe-rs project.
What do you think, @arkorobotics?