diff options
| author | Erik Doffagne <erik.doffagne@gmail.com> | 2019-10-02 22:41:32 +0200 |
|---|---|---|
| committer | Jack Humbert <jack.humb@gmail.com> | 2019-10-02 16:41:32 -0400 |
| commit | de386e5972597e89bda99022d30591ae2f6087b5 (patch) | |
| tree | 3ec1d405e2aa76ebd4f2ddaba6471f736fd54104 /docs/arm_debugging.md | |
| parent | 482ec79e5997b7ecab5102a0536fa3908ab68d02 (diff) | |
| download | qmk_firmware-de386e5972597e89bda99022d30591ae2f6087b5.tar.gz qmk_firmware-de386e5972597e89bda99022d30591ae2f6087b5.zip | |
Fixed typos in documentation (#6871)
* Fixed typos in documentation
* Update docs/arm_debugging.md
Co-Authored-By: fauxpark <fauxpark@gmail.com>
* Update docs/arm_debugging.md
Co-Authored-By: fauxpark <fauxpark@gmail.com>
Diffstat (limited to 'docs/arm_debugging.md')
| -rw-r--r-- | docs/arm_debugging.md | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/docs/arm_debugging.md b/docs/arm_debugging.md index 491dfe8ad..448b7a8fc 100644 --- a/docs/arm_debugging.md +++ b/docs/arm_debugging.md | |||
| @@ -6,15 +6,15 @@ This guide is catered towards advance users and assumes you can compile an ARM c | |||
| 6 | 6 | ||
| 7 | ## Installing the software | 7 | ## Installing the software |
| 8 | 8 | ||
| 9 | The main objective here is to get the MCU Eclipse IDE correcly installed on our machine. The necesarry instructions are derived from [this](https://gnu-mcu-eclipse.github.io/install/) install guide. | 9 | The main objective here is to get the MCU Eclipse IDE correctly installed on our machine. The necessary instructions are derived from [this](https://gnu-mcu-eclipse.github.io/install/) install guide. |
| 10 | 10 | ||
| 11 | ### The xPack Manager | 11 | ### The xPack Manager |
| 12 | 12 | ||
| 13 | This tool is a software package manager and it is used to help us get the necesarry depencencies. | 13 | This tool is a software package manager and it is used to help us get the necessary dependencies. |
| 14 | 14 | ||
| 15 | XPM runs using Node.js so grab that form [here](https://nodejs.org/en/). After installation, open a terminal and type `npm -v`. A reply with the version number means that the instalation was successful. | 15 | XPM runs using Node.js so grab that from [here](https://nodejs.org/en/). After installation, open a terminal and type `npm -v`. A reply with the version number means that the installation was successful. |
| 16 | 16 | ||
| 17 | XPM instalation instructions can be found [here](https://www.npmjs.com/package/xpm) and are OS specific. Entering `xpm --version` to your terminal should return the software version. | 17 | XPM installation instructions can be found [here](https://www.npmjs.com/package/xpm) and are OS specific. Entering `xpm --version` to your terminal should return the software version. |
| 18 | 18 | ||
| 19 | ### The ARM Toolchain | 19 | ### The ARM Toolchain |
| 20 | 20 | ||
| @@ -26,10 +26,10 @@ If you are using windows you need to install this! | |||
| 26 | 26 | ||
| 27 | `xpm install --global @gnu-mcu-eclipse/windows-build-tools` | 27 | `xpm install --global @gnu-mcu-eclipse/windows-build-tools` |
| 28 | 28 | ||
| 29 | ### Programer/Debugger Drivers | 29 | ### Programmer/Debugger Drivers |
| 30 | 30 | ||
| 31 | Now its the time to install your programer's drivers. This tutorial was made using an ST-Link v2 which you can get from almost anywhere. | 31 | Now it's time to install your programmer's drivers. This tutorial was made using an ST-Link v2 which you can get from almost anywhere. |
| 32 | If you have an ST-Link the drivers can be found [here](https://www.st.com/en/development-tools/stsw-link009.html) otherwise consult the manufuturer of your tool. | 32 | If you have an ST-Link the drivers can be found [here](https://www.st.com/en/development-tools/stsw-link009.html) otherwise consult the manufacturer of your tool. |
| 33 | 33 | ||
| 34 | ### OpenOCD | 34 | ### OpenOCD |
| 35 | 35 | ||
| @@ -84,4 +84,4 @@ Reset your keyboard. | |||
| 84 | Press the bug icon and if all goes well you should soon find yourself in the debug perspective. Here the program counter will pause at the beginning of the main function and way for you to press Play. Most of the features of all debuggers work on ARM MCUs but for exact details google is your friend! | 84 | Press the bug icon and if all goes well you should soon find yourself in the debug perspective. Here the program counter will pause at the beginning of the main function and way for you to press Play. Most of the features of all debuggers work on ARM MCUs but for exact details google is your friend! |
| 85 | 85 | ||
| 86 | 86 | ||
| 87 | Happy debugging! \ No newline at end of file | 87 | Happy debugging! |