Update READMEs, housekeeping
#1339
Conversation
|
|
jessebraham
force-pushed
the
fixes/housekeeping
branch
2 times, most recently
from
7ce9e83 to
b04f3d0
Compare
|
|
||
| Most traits defined by the [embedded-hal] family of packages are implemented as applicable. | ||
| For help getting started with this HAL, please refer to [The Rust on ESP Book] and the [documentation]. |
There was a problem hiding this comment.
Should we also include a link here to the no_std training as getting started guide? https://docs.esp-rs.org/no_std-training/
There was a problem hiding this comment.
Possibly, I am not quite sure how much detail to go into. I think the book probably mentions the training? But I'm also not against adding it, again just trying to find a good balance here.
|
It shows this for all READMEs except the one in the root:
Maybe that's normal ... I have no idea how those badges work in detail |
Works for me, although I've seen similar issues where it shows a werid messages |
This happens to me randomly, refreshing usually fixes it. Been happening for a long time, not sure why only that badge does it. There has to be some rate-limiting going on... somewhere, or something 😅 |
* Remove patches and just use git dependency for PACs instead * Various `README.md` normalization/updates for simpler packages * Update `README.md` for `esp-hal` and `esp-lp-hal` * Update repo-level `README.md`
A few mostly unrelated things going on here:
README.mdfiles:Possibly controversial (can revert this one if needed): added a minimal.vscode/settings.jsonjust to deal with the annoying TOML formatting issuesgit update-index --skip-worktree .vscode/settings.jsonwill ignore any subsequent changes to this file, so people can modify it as needed without the changes being trackedStill kind of annoying to deal with, don't think we can do anything at the git repo levelI would like to try and keep the READMEs minimal I think, just because things tend to fall out of sync. If there's anything else anybody thinks is worth mentioning please let me know, I have no problem updating this further. However, as I stated, I think we should try to defer to the book and documentation whenever possible.