aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorErik Doffagne <erik.doffagne@gmail.com>2019-10-02 22:41:32 +0200
committerJack Humbert <jack.humb@gmail.com>2019-10-02 16:41:32 -0400
commitde386e5972597e89bda99022d30591ae2f6087b5 (patch)
tree3ec1d405e2aa76ebd4f2ddaba6471f736fd54104
parent482ec79e5997b7ecab5102a0536fa3908ab68d02 (diff)
downloadqmk_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>
-rw-r--r--docs/arm_debugging.md16
-rw-r--r--docs/cli.md2
-rw-r--r--docs/hardware_keyboard_guidelines.md2
-rw-r--r--docs/newbs_flashing.md2
4 files changed, 11 insertions, 11 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
9The 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. 9The 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
13This tool is a software package manager and it is used to help us get the necesarry depencencies. 13This tool is a software package manager and it is used to help us get the necessary dependencies.
14 14
15XPM 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. 15XPM 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
17XPM 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. 17XPM 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
31Now 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. 31Now 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.
32If 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. 32If 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.
84Press 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! 84Press 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
87Happy debugging! \ No newline at end of file 87Happy debugging!
diff --git a/docs/cli.md b/docs/cli.md
index cb609e2a9..fe86cac1f 100644
--- a/docs/cli.md
+++ b/docs/cli.md
@@ -44,7 +44,7 @@ qmk setup # This will clone `qmk/qmk_firmware` and optionally set up your build
44We are looking for people to create and maintain a `qmk` package for more operating systems. If you would like to create a package for your OS please follow these guidelines: 44We are looking for people to create and maintain a `qmk` package for more operating systems. If you would like to create a package for your OS please follow these guidelines:
45 45
46* Follow best practices for your OS when they conflict with these guidelines 46* Follow best practices for your OS when they conflict with these guidelines
47 * Documment why in a comment when you do deviate 47 * Document why in a comment when you do deviate
48* Install using a virtualenv 48* Install using a virtualenv
49* Instruct the user to set the environment variable `QMK_HOME` to have the firmware source checked out somewhere other than `~/qmk_firmware`. 49* Instruct the user to set the environment variable `QMK_HOME` to have the firmware source checked out somewhere other than `~/qmk_firmware`.
50 50
diff --git a/docs/hardware_keyboard_guidelines.md b/docs/hardware_keyboard_guidelines.md
index c8aec40e0..5d9968f6d 100644
--- a/docs/hardware_keyboard_guidelines.md
+++ b/docs/hardware_keyboard_guidelines.md
@@ -67,7 +67,7 @@ The presence of this file means that the folder is a keyboard target and can be
67 67
68### `<keyboard_name.c>` 68### `<keyboard_name.c>`
69 69
70This is where you will write custom code for your keyboard. Typically you will write code to initialize and interface with the hardware in your keyboard. If your keyboard consists of only a key matrix with no LEDs, speakers, or other auxillary hardware this file can be blank. 70This is where you will write custom code for your keyboard. Typically you will write code to initialize and interface with the hardware in your keyboard. If your keyboard consists of only a key matrix with no LEDs, speakers, or other auxiliary hardware this file can be blank.
71 71
72The following functions are typically defined in this file: 72The following functions are typically defined in this file:
73 73
diff --git a/docs/newbs_flashing.md b/docs/newbs_flashing.md
index 4fb2f91d5..fa2170976 100644
--- a/docs/newbs_flashing.md
+++ b/docs/newbs_flashing.md
@@ -109,7 +109,7 @@ After it gets to this point, the build script will look for the DFU bootloader e
109 dfu-programmer: no device present. 109 dfu-programmer: no device present.
110 Error: Bootloader not found. Trying again in 5s. 110 Error: Bootloader not found. Trying again in 5s.
111 111
112Once it does this, you'll want to reset the controller. It should then show output similiar to this: 112Once it does this, you'll want to reset the controller. It should then show output similar to this:
113 113
114``` 114```
115*** Attempting to flash, please don't remove device 115*** Attempting to flash, please don't remove device