doc: Add VSCode and openOCD launcher documentation #46
Conversation
| 1. Install [Cortex-Debug](https://marketplace.visualstudio.com/items?itemName=marus25.cortex-debug) | ||
| 2. Create `launch.json` inside `.vscode` folder and add the following lines |
There was a problem hiding this comment.
| 1. Install [Cortex-Debug](https://marketplace.visualstudio.com/items?itemName=marus25.cortex-debug) | |
| 2. Create `launch.json` inside `.vscode` folder and add the following lines | |
| 1. Install [Cortex-Debug](https://marketplace.visualstudio.com/items?itemName=marus25.cortex-debug). | |
| 2. Create `launch.json` inside `.vscode` folder and add the following lines: |
| } | ||
| ] | ||
| } | ||
| ``` |
There was a problem hiding this comment.
add a blank line after
| > **Note:** You need to update "program" and "setupCommands" fields with the application you plan to flash and debug. | ||
|
|
||
| > **Please also note:** You need to update "miDebuggerPath" and "debugServerPath" fields with the system paths of your tool chain gdb and openOCD binary. |
There was a problem hiding this comment.
| > **Note:** You need to update "program" and "setupCommands" fields with the application you plan to flash and debug. | |
| > **Please also note:** You need to update "miDebuggerPath" and "debugServerPath" fields with the system paths of your tool chain gdb and openOCD binary. | |
| > **Note:** You need to update `program` and `setupCommands` fields with the application you plan to flash and debug. | |
| > **Please also note:** You need to update `miDebuggerPath` and `debugServerPath` fields with the system paths of your tool chain gdb and openOCD binary. |
There was a problem hiding this comment.
Is it openOCD or OpenOCD? I see both usages in this doc, so please make sure to be consistent there. Also, I'm pretty sure this repo has the ability to wrap up notes (https://github.com/TheThingsIndustries/generic-node-docs/blob/master/doc/themes/generic-node/layouts/shortcodes/note.html). So instead of using:
> **Note:** ...
you should use:
{{< note >}} ... {{</ note >}}
And btw this should be replaced not just in this PR, but whole docs. Let me know if you want me to do it for you.
There was a problem hiding this comment.
Yes you are right it's an OpenOCD.
I updated the notes in this PR and I think we can update the whole docs in another PR.
I created this issue #47
elsalahy
force-pushed
the
doc/openocd-debug
branch
from
09acbb4 to
3a05995
Compare
|
Thanks @nejraselimovic for the review, can you please take anther look. |
Summary
Added VSCode launcher to use openOCD in the flashing and debugging process.
Closes #9
Changes
Notes for Reviewers
...
Checklist
make server, posted screenshots, verified external links.new-in-versionshortcode, according to the guidelines in CONTRIBUTING.