Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix: Added pinout documentation to the stlink platform #1633

Merged
merged 1 commit into from
Oct 1, 2023

Conversation

dragonmux
Copy link
Member

Detailed description

This PR adds the pinout documentation figured out in #1632 to the README.md for the ST-Link platform.

While we aren't very satisfied by this representation of the pinout, it starts to address the documentation issue of the stlink and swlink platforms a touch.

Your checklist for this pull request

  • I've read the Code of Conduct
  • I've read the guidelines for contributing to this repository
  • It builds for hardware native (make PROBE_HOST=native)
  • It builds as BMDA (make PROBE_HOST=hosted)
  • I've tested it to the best of my ability
  • My commit messages provide a useful short description of what the commits do

Closing issues

@dragonmux dragonmux added this to the v1.10 milestone Sep 29, 2023
@dragonmux dragonmux added Documentation Project documentation Foreign Host Board Non Native hardware to runing Black Magic firmware on labels Sep 29, 2023
@dragonmux dragonmux changed the title stlink: Documented the main and alternative pinouts Fix: Added pinout documentation to the stlink platform Sep 29, 2023
@dragonmux dragonmux requested a review from esden September 29, 2023 22:57
@dragonmux dragonmux force-pushed the fix/stlink-pinout-documentation branch from f644dbe to 8845866 Compare September 30, 2023 00:18
Copy link
Member

@esden esden left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@esden esden merged commit 4c73cdc into main Oct 1, 2023
6 checks passed
@dragonmux dragonmux deleted the fix/stlink-pinout-documentation branch October 1, 2023 23:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Project documentation Foreign Host Board Non Native hardware to runing Black Magic firmware on
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants