Fix spelling in docs and board READMEs

KMKfw · Oct 5, 2023 · 3745867 · 3745867
1 parent cbeccc8
commit 3745867
Show file tree

Hide file tree

Showing 57 changed files with 586 additions and 506 deletions.
diff --git a/README.md b/README.md
@@ -26,7 +26,7 @@ configuration, documentation, etc. concerns.
 
 - Fully configured through a single, easy to understand Python file that lives
   on a "flash-drive"-esque space on your microcontroller - edit on the go
-  without DFU or other devtooling available!
+  without DFU or other dev tooling available!
 - Single-piece or [two-piece split
   keyboards](/docs/en/split_keyboards.md)
   are supported
@@ -52,7 +52,7 @@ Our getting started guide can be found
 Please have a look at the [contributing document](/docs/en/contributing.md), 
 where you can find details about the workflow and code style. If you have 
 specific questions feel free to ask in the [KMK development stream](https://kmkfw.zulipchat.com/#narrow/stream/384078-KMK-development) 
-on zulip.
+on Zulip.
 
 ## License, Copyright, and Legal
 

diff --git a/boards/Pico14/README.md b/boards/Pico14/README.md
@@ -2,6 +2,6 @@
 
 ![Pico14](https://www.boltind.com/wp-content/uploads/2022/01/PXL_20220119_171113903-scaled.jpg)
 
-Pico 14 Numerical Keypad / Macro Pad PCB’s and Hardware Kit.
+Pico 14 Numerical Keypad / Macro Pad PCBs and Hardware Kit.
 
 `kb.py` is designed to work with the Pi Pico.
diff --git a/boards/anavi/anavi-arrows/README.md b/boards/anavi/anavi-arrows/README.md
@@ -1,12 +1,12 @@
 # ANAVI Arrows
 
-ANAVI Arrows is an open source, programmable mechanical keyboard with 4 hot-swappable mechanical switches, RGB WS2812B underlighting and yellow backlit a rotary encoder, [Seeed XIAO RP2040](https://www.seeedstudio.com/XIAO-RP2040-v1-0-p-5026.html) and a mini OLED I2C yellow-blue display.
+ANAVI Arrows is an open source, programmable mechanical keyboard with 4 hot-swappable mechanical switches, RGB WS2812B underlighting and yellow backlight a rotary encoder, [Seeed XIAO RP2040](https://www.seeedstudio.com/XIAO-RP2040-v1-0-p-5026.html) and a mini OLED I2C yellow-blue display.
 
 ANAVI Arrows has been designed with the cross platform and open source electronics design automation suite KiCad. All KiCad [files and schematics are available at GitHub](https://github.com/anavitechnology/anavi-arrows) under [Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0)](https://creativecommons.org/licenses/by-sa/4.0/).
 
 Extensions enabled by default:
 - [Encoder](/docs/en/encoder.md) Twist control for all the things
-- [LED](/docs/en/led.md) Light your keys up (for backlit)
+- [LED](/docs/en/led.md) Light your keys up (for backlight)
 - [RGB](/docs/en/rgb.md) Light it up (for underlighting)
 - [MediaKeys](/docs/en/media_keys.md) Control volume and other media functions
 - [PEG_OLED](/docs/peg_oled_display.md) Show information on the mini OLED display
diff --git a/boards/anavi/macro-pad-10/README.md b/boards/anavi/macro-pad-10/README.md
@@ -1,11 +1,11 @@
 # ANAVI Macro Pad 10
 
-ANAVI Macro Pad 10 is an open source, programmable mechanical keyboard with 9 hot-swappable mechanical switches, RGB WS2812B underlighting and yellow backlit a rotary encoder and [Seeed XIAO RP2040](https://www.seeedstudio.com/XIAO-RP2040-v1-0-p-5026.html).
+ANAVI Macro Pad 10 is an open source, programmable mechanical keyboard with 9 hot-swappable mechanical switches, RGB WS2812B underlighting and yellow backlight a rotary encoder and [Seeed XIAO RP2040](https://www.seeedstudio.com/XIAO-RP2040-v1-0-p-5026.html).
 
 ANAVI Macro Pad 10 has been designed with the cross platform and open source electronics design automation suite KiCad. All KiCad [files and schematics are available at GitHub](https://github.com/anavitechnology/anavi-macro-pad-10) under [Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0)](https://creativecommons.org/licenses/by-sa/4.0/).
 
 Extensions enabled by default:
 - [Encoder](/docs/en/encoder.md) Twist control for all the things
-- [LED](/docs/en/led.md) Light your keys up (for backlit)
+- [LED](/docs/en/led.md) Light your keys up (for backlight)
 - [RGB](/docs/en/rgb.md) Light it up (for underlighting)
 - [MediaKeys](/docs/en/media_keys.md) Control volume and other media functions
diff --git a/boards/anavi/macro-pad-12/README.md b/boards/anavi/macro-pad-12/README.md
@@ -1,12 +1,12 @@
 # ANAVI Macro Pad 12
 
-ANAVI Macro Pad 12 is an open source, programmable mechanical keyboard with 9 hot-swappable mechanical switches, RGB WS2812B underlighting and yellow backlit a rotary encoder and [Seeed XIAO RP2040](https://www.seeedstudio.com/XIAO-RP2040-v1-0-p-5026.html).
+ANAVI Macro Pad 12 is an open source, programmable mechanical keyboard with 9 hot-swappable mechanical switches, RGB WS2812B underlighting and yellow backlight a rotary encoder and [Seeed XIAO RP2040](https://www.seeedstudio.com/XIAO-RP2040-v1-0-p-5026.html).
 
 ANAVI Macro Pad 12 has been designed with the cross platform and open source electronics design automation suite KiCad. All KiCad [files and schematics are available at GitHub](https://github.com/anavitechnology/anavi-macro-pad-12) under [Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0)](https://creativecommons.org/licenses/by-sa/4.0/).
 
 Extensions enabled by default:
 - [Encoder](/docs/en/encoder.md) Twist control for all the things
-- [LED](/docs/en/led.md) Light your keys up (for backlit)
+- [LED](/docs/en/led.md) Light your keys up (for backlight)
 - [RGB](/docs/en/rgb.md) Light it up (for underlighting)
 - [MediaKeys](/docs/en/media_keys.md) Control volume and other media functions
 - [PEG_OLED](/docs/peg_oled_display.md) Show information on the mini OLED display
diff --git a/boards/boardsource/Lulu/README.md b/boards/boardsource/Lulu/README.md
@@ -2,7 +2,7 @@
 
 ![Lulu](https://boardsource.imgix.net/c93fba70-71bc-11ec-bb73-09003ca81902.jpg?raw=true)
 
-Based on the form factor of the Lily58, but with new features. The Lulu is a 58 key split keyboard design by Boardsource, featuring a 6x4 columnar stagger and 4 thumb cluster keys on each hand. The Lulu is a perfect choice for people who want to be on a split keyboard but still want to have a fairly standard amount of keys, and a premium case avaliable.
+Based on the form factor of the Lily58, but with new features. The Lulu is a 58 key split keyboard design by Boardsource, featuring a 6x4 columnar stagger and 4 thumb cluster keys on each hand. The Lulu is a perfect choice for people who want to be on a split keyboard but still want to have a fairly standard amount of keys, and a premium case available.
 
 Hardware Availability: [PCB & Case Source](https://boardsource.xyz/store/5ec9df84c6b834480de6c3d0)  
 kb.py is designed to work with the PCBA version directly from them.

diff --git a/boards/boardsource/unicorne/README.md b/boards/boardsource/unicorne/README.md
@@ -1,8 +1,8 @@
 # Unicorne
 
-Based on the legendary corne (crkbd) from Foostan with more features than ever before.
+Based on the legendary Corne (CRKBD) from Foostan with more features than ever before.
 
-- Prebuilt at the factory
+- Pre-built at the factory
 - Hotswap sockets
 - RP2040 with 16MB of ROM for tons of room for fun things!
 - OLED screens
@@ -13,5 +13,5 @@ Extensions enabled by default
 - [Layers](/docs/en/layers.md) Need more keys than switches? Use layers.
 - [PEG_RGB](/docs/en/peg_rgb_matrix.md) Light it up!
 - [PEG_OLED](/docs/en/peg_oled_display.md) Screens to see things on of course.
-- [Oneshot](/docs/en/oneshot.md) Deadkeys, for faster typing
+- [Oneshot](/docs/en/oneshot.md) Dead keys, for faster typing
 - [Combos](/docs/en/combos) Making more keys from pushing multiple keys.
diff --git a/boards/crowboard/README.md b/boards/crowboard/README.md
@@ -1,8 +1,5 @@
 # Crowboard
-![crowboard](https://i.imgur.com/Rg7IYPw.jpg)
+![Crowboard](https://i.imgur.com/Rg7IYPw.jpg)
  Single Board 34/36 Key Keyboard Based on Raspberry pi Pico
-
- [Link to the Github repo](https://github.com/doesntfazer/CrowBoard)
-
-
- You can Buy this keyboard at KeyboardDweebs.net
+
+[Link to the GitHub repository](https://github.com/doesntfazer/CrowBoard)
diff --git a/boards/dactyl/README.md b/boards/dactyl/README.md
@@ -1,9 +1,9 @@
 # Dactyl
 
-![Dacytl1](https://raw.githubusercontent.com/adereth/dactyl-cave/master/resources/glamourshot.png)
+![Dactyl1](https://raw.githubusercontent.com/adereth/dactyl-cave/master/resources/glamourshot.png)
 ![Dactyl2](https://i.imgur.com/Bo11dGx.jpeg)
 
-A split body, concave shaped key well, columnar keyboard with a 6 key thumb cluster that takes inspiration from the Kinesis Advantage keyboard range.
+A split body, concave shaped keywell, columnar keyboard with a 6 key thumb cluster that takes inspiration from the Kinesis Advantage keyboard range.
 
 Hardware Availability: [Case Files](https://github.com/adereth/dactyl-keyboard)
 
@@ -15,7 +15,7 @@ KMK's rendition of the Dactyl requires two micro controllers rather than the ori
 
 ## KMK Specifics
 
-Extentions enabled by default  
+Extensions enabled by default  
 - [Layers](/docs/en/layers.md)
 - [Split](/docs/en/split_keyboards.md): Configured to 1-wire UART to match legacy configuration. Please see documentation for enabling 2-wire UART or, for capable controllers, Bluetooth
 
@@ -31,9 +31,9 @@ from kmk.quickpin.pro_micro.kb2040 import pinout as pins
 
 Electronically:
 1. [Dactyl CC](https://github.com/mjohns/dactyl-cc) and [Ergo S-1](https://github.com/wizarddata/Ergo-S-1) are identical to one another
-2. Both these boards are identical to the Dactyl with one difference; on the finger key-well, they do not have the bottom row, outer column key (per half) of the Dactyl
+2. Both these boards are identical to the Dactyl with one difference; on the finger keywell, they do not have the bottom row, outer column key (per half) of the Dactyl
 
-To accomodate this, in files:
+To accommodate this, in files:
 - **`kb.py`**  
 `coord_mapping` element: Delete '`24, `' and '`65,`'
 - **`main.py`**  

diff --git a/boards/dactyl_lightcycle/README.md b/boards/dactyl_lightcycle/README.md
@@ -1,23 +1,23 @@
-# Dactyl Lightcycle
+# Dactyl LightCycle
 
-![DacytlLightcycle](https://pbs.twimg.com/media/C_lE5BUU0AEufDT?format=jpg)
+![Dactyl LightCycle](https://pbs.twimg.com/media/C_lE5BUU0AEufDT?format=jpg)
 
-A handwired, split body, concave shaped key well, columnar keyboard -- the Dactyl Lightcycle is a variation of the [Dactyl](/boards/dactyl/) keyboard.  
+A handwired, split body, concave shaped keywell, columnar keyboard -- the Dactyl LightCycle is a variation of the [Dactyl](/boards/dactyl/) keyboard.  
 Differences from the Dactyl are:
 1. Top (number) row removed
 2. Thumb cluster is 5 keys, down from 6
 
-[Case Files](https://github.com/adereth/dactyl-keyboard/tree/master/things): Files, in linked GitHub directory, with name beginning "lightcycle" are applicable.
+[Case Files](https://github.com/adereth/dactyl-keyboard/tree/master/things): Files, in linked GitHub directory, with name beginning "LightCycle" are applicable.
 
-KMK's rendition of the Dactyl Lightcycle requires two micro controllers, rather than the Dactyl's original implementation of a micro controller and I/O expander. 
+KMK's rendition of the Dactyl LightCycle requires two micro controllers, rather than the Dactyl's original implementation of a micro controller and I/O expander. 
 
 ## Case Files Generator
 
 [Dactyl Generator](https://ryanis.cool/dactyl), created by [rianadon](https://github.com/rianadon), is a web based file generator that negates composing case files using a programming language, which was a requirement when using the GitHub repository for this board, by instead compiling case files based on options and parameters configured in a web front end.
 
 ## KMK Specifics
 
-Extentions enabled by default:
+Extensions enabled by default:
 - [Layers](/docs/en/layers.md)
 - [Split](/docs/en/split_keyboards.md): Configured to 1-wire UART to match legacy configuration. Please see documentation for enabling 2-wire UART or, for capable controllers, Bluetooth
 - [HoldTap](/docs/en/holdtap.md)

diff --git a/boards/dactyl_manuform/README.md b/boards/dactyl_manuform/README.md
@@ -1,9 +1,9 @@
 # Dactyl ManuForm
 
-![WiredDm](https://i.imgur.com/7y0Vbyd.jpg)
+![Wired ManuForm](https://i.imgur.com/7y0Vbyd.jpg)
 *Two wired Dactyl ManuForm 4x6 variants*
 
-![WirelessDm](https://i.imgur.com/FpkRuCH.jpeg)
+![Wireless ManuForm](https://i.imgur.com/FpkRuCH.jpeg)
 *Wireless Dactyl ManuForm 5x6 variant*
 
 The [Dactyl ManuForm](https://github.com/tshort/dactyl-keyboard) is a handwired, split bodied, tented, curved keywell keyboard.  
@@ -12,9 +12,9 @@ Information for building this keyboard is found in first link.
 
 ## Variants
 
-Dactyl ManuForm's are built in variations that cater for different row and column counts, and thumb clusters.  
+Dactyl ManuForms are built in variations that cater for different row and column counts, and thumb clusters.  
 Variants are denoted as `RowCount`*x*`ColumnCount` and share the common configuration of:
-- The finger key-well bottom row has 2 keys; 1 each in ring and middle columns.
+- The finger keywell bottom row has 2 keys; 1 each in ring and middle columns.
     - Exception to this rule is the 7 column variants that have two additional keys in this row.
 - The thumb cluster has 6 keys, arranged in 2 columns by 3 rows.
 
@@ -28,17 +28,17 @@ Variants are denoted as `RowCount`*x*`ColumnCount` and share the common configur
 ### Column
 | Count | Description |
 | --- | --- |
-| 5 | A column for each finger with additiona index finger column |  
+| 5 | A column for each finger with additional index finger column |  
 | 6 | As *5 columns* with additional pinky finger column |
 | 7 | As *6 columns* with either an additional index finger column (`5x7`) or additional pinky column (`6x7`) |
 
 ## Extended Bottom Row
 
-Further to this board's customisable ethos, the bottom row of the finger key-well can be extended, outward, from the default two keys.
+Further to this board's customizable ethos, the bottom row of the finger keywell can be extended, outward, from the default two keys.
 
 *Note: This does not apply to the `5x7` variant, as its bottom row is already extended*
 
-To accomodate this, in files of chosen variant:
+To accommodate this, in files of chosen variant:
 ### `kb.py`  
 `coord_mapping` element: Populate the extended row positions with numbers that continue numerical pattern of each half.  
 e.g. in the case of `4x6` variant:
@@ -54,7 +54,7 @@ e.g. in the case of `4x6` variant:
 
 ## KMK Specifics
 
-Extentions enabled by default:  
+Extensions enabled by default:  
 - [Layers](/docs/en/layers.md): As many as you want/need
 - [Split](/docs/en/split_keyboards.md): Configured to 1-wire UART to match legacy configuration. Please see documentation for enabling 2-wire UART or, for capable controllers, Bluetooth.
 

diff --git a/boards/dactyl_manuform_carbonfet/README.md b/boards/dactyl_manuform_carbonfet/README.md
@@ -1,21 +1,21 @@
 # Dactyl ManuForm Carbonfet
-The [Dactyl ManuForm Carbonfet](https://github.com/carbonfet/dactyl-manuform) is a handwired, split bodied, tented, curved key-well keyboard.  
+The [Dactyl ManuForm Carbonfet](https://github.com/carbonfet/dactyl-manuform) is a handwired, split bodied, tented, curved keywell keyboard.  
 Forked from the [Dactyl ManuForm Mini](/boards/dactyl_manuform_mini), the Dactyl ManuForm Carbonfet appends the 5 key thumb cluster of the former with an additional key into a 2 row by 3 column arrangement.
 
 ![White](https://i.imgur.com/0ugz1C9.jpg)  
-*Dactyl Manuform Carbonfet 5x6 variant*
+*Dactyl ManuForm Carbonfet 5x6 variant*
 
 ## Variants
-Dactyl Manuform Carbonfets are built in variations that cater for different row and column counts.  
+Dactyl ManuForm Carbonfets are built in variations that cater for different row and column counts.  
 Variants are denoted as `RowCount`*x*`ColumnCount` and share the common configuration of:
-- The finger key-well bottom row has 2 keys; 1 each in ring and middle columns.
+- The finger keywell bottom row has 2 keys; 1 each in ring and middle columns.
    Exception to this rule is the `5x7` variant that has two additional keys in this row.
-- The thumb cluster has 5 keys: 2 (row) x 3 (column) arrangement with bottom left position ommited for left half, this arrangment mirrored for right half.
+- The thumb cluster has 5 keys: 2 (row) x 3 (column) arrangement with bottom left position omitted for left half, this arrangement mirrored for right half.
 
 ### Row
 | Count | Description                                                                                                                |
 | ----- | -------------------------------------------------------------------------------------------------------------------------- |
-|     4 | Three rows, typically for alphabet and some punctuation characters, with two keys in bottom row of finger key-well section |
+|     4 | Three rows, typically for alphabet and some punctuation characters, with two keys in bottom row of finger keywell section |
 |     5 | As *4 rows* with number row above                                                                                          |
 |     6 | As *5 rows* with function row above                                                                                        |
 
@@ -27,11 +27,11 @@ Variants are denoted as `RowCount`*x*`ColumnCount` and share the common configur
 |     7 | As *6 columns* with either an additional index finger column (`5x7`) or additional pinky column (`6x7`) |
 
 ## Extended Bottom Row
-Further to this board's customisable ethos, the bottom row of the finger key-well can be extended, outward, from the default two keys.
+Further to this board's customizable ethos, the bottom row of the finger keywell can be extended, outward, from the default two keys.
 
 *Note: This does not apply to the `5x7` variant, as its bottom row is already extended*
 
-To accomodate this, in files of chosen variant:
+To accommodate this, in files of chosen variant:
 
 ### `kb.py`
 `coord_mapping` element: Populate the extended row positions with numbers that continue numerical pattern of each half.  
@@ -42,8 +42,8 @@ e.g. in the case of `4x6` variant:
 ### `main.py`  
 `keyboard.keymap` element: For each layer, append with keycodes in the respective extended bottom row positions.
 
-## KMk Specifics
-Extentions enabled by default:  
+## KMK Specifics
+Extensions enabled by default:  
 - [Layers](/docs/en/layers.md)
 - [Split](/docs/en/split_keyboards.md): Configured to 1-wire UART to match legacy configuration. Please see documentation for enabling 2-wire UART or, for capable controllers, Bluetooth.