README: fix style issues/add flash instructions #108
Conversation
igoropaniuk
commented
Dec 11, 2024
•
igoropaniuk
commented
- Address markdown style issues reported by the linter
- Add initial flash instructions for Qualcomm® RB3 Gen 2 Development Kit.
igoropaniuk
requested review from
quic-vkraleti,
ricardosalveti,
sbanerjee-quic and
ndechesne
as code owners
igoropaniuk
force-pushed
the
flash_instructions
branch
2 times, most recently
from
1f43108 to
4618dec
Compare
igoropaniuk
changed the title
|
|
||
| Make sure that ModemManager is not running, disable it if necessary. | ||
| Location of all DIP switches, USB debug port and buttons (`F_DL` for instance) | ||
| can be found on [RB3 Gen 2 Quick Start Guide](https://docs.qualcomm.com/bundle/publicresource/topics/80-70014-253/ubuntu_host.html). |
There was a problem hiding this comment.
I think having the generic instructions here is fine, but this layer is expected to support multiple machines (there is already support for ride), so should we isolate the board specific instructions and just have a link instead?
There was a problem hiding this comment.
For RIDE one needs to use alpaca to set the EDL mode. I don't think there are public instructions available for that.
There was a problem hiding this comment.
@ricardosalveti makes sense, will do
There was a problem hiding this comment.
I've tried to make flash instructions as much board-agnostic as possible. I've moved board specific details to a dedicated section.
igoropaniuk
force-pushed
the
flash_instructions
branch
from
4618dec to
563d3e6
Compare
|
@ricardosalveti @mwasilew @ndechesne any additional comments/suggestions? |
igoropaniuk
force-pushed
the
flash_instructions
branch
from
6f57b57 to
563d3e6
Compare
|
I am not sure I like duplicating the documentation here... but for now we should go ahead and merge. we can always reorganize things later once we have a better idea about how the whole thing will work out. |
Fix markdown style issues using markdownlint tool [1]: $ cat README.md | mdl (stdin):70: MD004 Unordered list style (stdin):71: MD004 Unordered list style (stdin):72: MD004 Unordered list style (stdin):73: MD004 Unordered list style (stdin):74: MD004 Unordered list style (stdin):39: MD010 Hard tabs (stdin):40: MD010 Hard tabs (stdin):41: MD010 Hard tabs (stdin):43: MD010 Hard tabs (stdin):44: MD010 Hard tabs (stdin):45: MD010 Hard tabs (stdin):47: MD010 Hard tabs (stdin):48: MD010 Hard tabs (stdin):49: MD010 Hard tabs (stdin):3: MD013 Line length (stdin):9: MD013 Line length (stdin):26: MD013 Line length (stdin):34: MD013 Line length (stdin):36: MD013 Line length (stdin):54: MD013 Line length (stdin):61: MD013 Line length (stdin):78: MD013 Line length (stdin):33: MD022 Headers should be surrounded by blank lines (stdin):42: MD029 Ordered list item prefix (stdin):46: MD029 Ordered list item prefix (stdin):39: MD031 Fenced code blocks should be surrounded by blank lines (stdin):41: MD031 Fenced code blocks should be surrounded by blank lines (stdin):43: MD031 Fenced code blocks should be surrounded by blank lines (stdin):45: MD031 Fenced code blocks should be surrounded by blank lines (stdin):47: MD031 Fenced code blocks should be surrounded by blank lines (stdin):49: MD031 Fenced code blocks should be surrounded by blank lines (stdin):57: MD034 Bare URL used [1] https://github.com/markdownlint/markdownlint Signed-off-by: Igor Opaniuk <[email protected]>
Add initial flash instructions for Qualcomm® RB3 Gen 2 Development Kit. Signed-off-by: Igor Opaniuk <[email protected]>
igoropaniuk
force-pushed
the
flash_instructions
branch
from
563d3e6 to
7b54e66
Compare
|
Rebased onto the latest main |
|
In order to merge we need a +1 from @mwasilew, as he requested changes. |
|
Sorry, I missed the fixes from @igoropaniuk. |
