Skip to content

Commit 3745867

Browse files
committed
Fix spelling in docs and board READMEs
1 parent cbeccc8 commit 3745867

File tree

57 files changed

+586
-506
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+586
-506
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ configuration, documentation, etc. concerns.
2626

2727
- Fully configured through a single, easy to understand Python file that lives
2828
on a "flash-drive"-esque space on your microcontroller - edit on the go
29-
without DFU or other devtooling available!
29+
without DFU or other dev tooling available!
3030
- Single-piece or [two-piece split
3131
keyboards](/docs/en/split_keyboards.md)
3232
are supported
@@ -52,7 +52,7 @@ Our getting started guide can be found
5252
Please have a look at the [contributing document](/docs/en/contributing.md),
5353
where you can find details about the workflow and code style. If you have
5454
specific questions feel free to ask in the [KMK development stream](https://kmkfw.zulipchat.com/#narrow/stream/384078-KMK-development)
55-
on zulip.
55+
on Zulip.
5656

5757
## License, Copyright, and Legal
5858

boards/Pico14/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22

33
![Pico14](https://www.boltind.com/wp-content/uploads/2022/01/PXL_20220119_171113903-scaled.jpg)
44

5-
Pico 14 Numerical Keypad / Macro Pad PCB’s and Hardware Kit.
5+
Pico 14 Numerical Keypad / Macro Pad PCBs and Hardware Kit.
66

77
`kb.py` is designed to work with the Pi Pico.

boards/anavi/anavi-arrows/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# ANAVI Arrows
22

3-
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.
3+
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.
44

55
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/).
66

77
Extensions enabled by default:
88
- [Encoder](/docs/en/encoder.md) Twist control for all the things
9-
- [LED](/docs/en/led.md) Light your keys up (for backlit)
9+
- [LED](/docs/en/led.md) Light your keys up (for backlight)
1010
- [RGB](/docs/en/rgb.md) Light it up (for underlighting)
1111
- [MediaKeys](/docs/en/media_keys.md) Control volume and other media functions
1212
- [PEG_OLED](/docs/peg_oled_display.md) Show information on the mini OLED display

boards/anavi/macro-pad-10/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# ANAVI Macro Pad 10
22

3-
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).
3+
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).
44

55
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/).
66

77
Extensions enabled by default:
88
- [Encoder](/docs/en/encoder.md) Twist control for all the things
9-
- [LED](/docs/en/led.md) Light your keys up (for backlit)
9+
- [LED](/docs/en/led.md) Light your keys up (for backlight)
1010
- [RGB](/docs/en/rgb.md) Light it up (for underlighting)
1111
- [MediaKeys](/docs/en/media_keys.md) Control volume and other media functions

boards/anavi/macro-pad-12/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# ANAVI Macro Pad 12
22

3-
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).
3+
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).
44

55
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/).
66

77
Extensions enabled by default:
88
- [Encoder](/docs/en/encoder.md) Twist control for all the things
9-
- [LED](/docs/en/led.md) Light your keys up (for backlit)
9+
- [LED](/docs/en/led.md) Light your keys up (for backlight)
1010
- [RGB](/docs/en/rgb.md) Light it up (for underlighting)
1111
- [MediaKeys](/docs/en/media_keys.md) Control volume and other media functions
1212
- [PEG_OLED](/docs/peg_oled_display.md) Show information on the mini OLED display

boards/boardsource/Lulu/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
![Lulu](https://boardsource.imgix.net/c93fba70-71bc-11ec-bb73-09003ca81902.jpg?raw=true)
44

5-
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.
5+
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.
66

77
Hardware Availability: [PCB & Case Source](https://boardsource.xyz/store/5ec9df84c6b834480de6c3d0)
88
kb.py is designed to work with the PCBA version directly from them.

boards/boardsource/unicorne/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Unicorne
22

3-
Based on the legendary corne (crkbd) from Foostan with more features than ever before.
3+
Based on the legendary Corne (CRKBD) from Foostan with more features than ever before.
44

5-
- Prebuilt at the factory
5+
- Pre-built at the factory
66
- Hotswap sockets
77
- RP2040 with 16MB of ROM for tons of room for fun things!
88
- OLED screens
@@ -13,5 +13,5 @@ Extensions enabled by default
1313
- [Layers](/docs/en/layers.md) Need more keys than switches? Use layers.
1414
- [PEG_RGB](/docs/en/peg_rgb_matrix.md) Light it up!
1515
- [PEG_OLED](/docs/en/peg_oled_display.md) Screens to see things on of course.
16-
- [Oneshot](/docs/en/oneshot.md) Deadkeys, for faster typing
16+
- [Oneshot](/docs/en/oneshot.md) Dead keys, for faster typing
1717
- [Combos](/docs/en/combos) Making more keys from pushing multiple keys.

boards/crowboard/README.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,5 @@
11
# Crowboard
2-
![crowboard](https://i.imgur.com/Rg7IYPw.jpg)
2+
![Crowboard](https://i.imgur.com/Rg7IYPw.jpg)
33
Single Board 34/36 Key Keyboard Based on Raspberry pi Pico
4-
5-
[Link to the Github repo](https://github.com/doesntfazer/CrowBoard)
6-
7-
8-
You can Buy this keyboard at KeyboardDweebs.net
4+
5+
[Link to the GitHub repository](https://github.com/doesntfazer/CrowBoard)

boards/dactyl/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Dactyl
22

3-
![Dacytl1](https://raw.githubusercontent.com/adereth/dactyl-cave/master/resources/glamourshot.png)
3+
![Dactyl1](https://raw.githubusercontent.com/adereth/dactyl-cave/master/resources/glamourshot.png)
44
![Dactyl2](https://i.imgur.com/Bo11dGx.jpeg)
55

6-
A split body, concave shaped key well, columnar keyboard with a 6 key thumb cluster that takes inspiration from the Kinesis Advantage keyboard range.
6+
A split body, concave shaped keywell, columnar keyboard with a 6 key thumb cluster that takes inspiration from the Kinesis Advantage keyboard range.
77

88
Hardware Availability: [Case Files](https://github.com/adereth/dactyl-keyboard)
99

@@ -15,7 +15,7 @@ KMK's rendition of the Dactyl requires two micro controllers rather than the ori
1515

1616
## KMK Specifics
1717

18-
Extentions enabled by default
18+
Extensions enabled by default
1919
- [Layers](/docs/en/layers.md)
2020
- [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
2121

@@ -31,9 +31,9 @@ from kmk.quickpin.pro_micro.kb2040 import pinout as pins
3131

3232
Electronically:
3333
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
34-
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
34+
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
3535

36-
To accomodate this, in files:
36+
To accommodate this, in files:
3737
- **`kb.py`**
3838
`coord_mapping` element: Delete '`24, `' and '`65,`'
3939
- **`main.py`**

boards/dactyl_lightcycle/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
1-
# Dactyl Lightcycle
1+
# Dactyl LightCycle
22

3-
![DacytlLightcycle](https://pbs.twimg.com/media/C_lE5BUU0AEufDT?format=jpg)
3+
![Dactyl LightCycle](https://pbs.twimg.com/media/C_lE5BUU0AEufDT?format=jpg)
44

5-
A handwired, split body, concave shaped key well, columnar keyboard -- the Dactyl Lightcycle is a variation of the [Dactyl](/boards/dactyl/) keyboard.
5+
A handwired, split body, concave shaped keywell, columnar keyboard -- the Dactyl LightCycle is a variation of the [Dactyl](/boards/dactyl/) keyboard.
66
Differences from the Dactyl are:
77
1. Top (number) row removed
88
2. Thumb cluster is 5 keys, down from 6
99

10-
[Case Files](https://github.com/adereth/dactyl-keyboard/tree/master/things): Files, in linked GitHub directory, with name beginning "lightcycle" are applicable.
10+
[Case Files](https://github.com/adereth/dactyl-keyboard/tree/master/things): Files, in linked GitHub directory, with name beginning "LightCycle" are applicable.
1111

12-
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.
12+
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.
1313

1414
## Case Files Generator
1515

1616
[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.
1717

1818
## KMK Specifics
1919

20-
Extentions enabled by default:
20+
Extensions enabled by default:
2121
- [Layers](/docs/en/layers.md)
2222
- [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
2323
- [HoldTap](/docs/en/holdtap.md)

boards/dactyl_manuform/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Dactyl ManuForm
22

3-
![WiredDm](https://i.imgur.com/7y0Vbyd.jpg)
3+
![Wired ManuForm](https://i.imgur.com/7y0Vbyd.jpg)
44
*Two wired Dactyl ManuForm 4x6 variants*
55

6-
![WirelessDm](https://i.imgur.com/FpkRuCH.jpeg)
6+
![Wireless ManuForm](https://i.imgur.com/FpkRuCH.jpeg)
77
*Wireless Dactyl ManuForm 5x6 variant*
88

99
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.
1212

1313
## Variants
1414

15-
Dactyl ManuForm's are built in variations that cater for different row and column counts, and thumb clusters.
15+
Dactyl ManuForms are built in variations that cater for different row and column counts, and thumb clusters.
1616
Variants are denoted as `RowCount`*x*`ColumnCount` and share the common configuration of:
17-
- The finger key-well bottom row has 2 keys; 1 each in ring and middle columns.
17+
- The finger keywell bottom row has 2 keys; 1 each in ring and middle columns.
1818
- Exception to this rule is the 7 column variants that have two additional keys in this row.
1919
- The thumb cluster has 6 keys, arranged in 2 columns by 3 rows.
2020

@@ -28,17 +28,17 @@ Variants are denoted as `RowCount`*x*`ColumnCount` and share the common configur
2828
### Column
2929
| Count | Description |
3030
| --- | --- |
31-
| 5 | A column for each finger with additiona index finger column |
31+
| 5 | A column for each finger with additional index finger column |
3232
| 6 | As *5 columns* with additional pinky finger column |
3333
| 7 | As *6 columns* with either an additional index finger column (`5x7`) or additional pinky column (`6x7`) |
3434

3535
## Extended Bottom Row
3636

37-
Further to this board's customisable ethos, the bottom row of the finger key-well can be extended, outward, from the default two keys.
37+
Further to this board's customizable ethos, the bottom row of the finger keywell can be extended, outward, from the default two keys.
3838

3939
*Note: This does not apply to the `5x7` variant, as its bottom row is already extended*
4040

41-
To accomodate this, in files of chosen variant:
41+
To accommodate this, in files of chosen variant:
4242
### `kb.py`
4343
`coord_mapping` element: Populate the extended row positions with numbers that continue numerical pattern of each half.
4444
e.g. in the case of `4x6` variant:
@@ -54,7 +54,7 @@ e.g. in the case of `4x6` variant:
5454

5555
## KMK Specifics
5656

57-
Extentions enabled by default:
57+
Extensions enabled by default:
5858
- [Layers](/docs/en/layers.md): As many as you want/need
5959
- [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.
6060

boards/dactyl_manuform_carbonfet/README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
# Dactyl ManuForm Carbonfet
2-
The [Dactyl ManuForm Carbonfet](https://github.com/carbonfet/dactyl-manuform) is a handwired, split bodied, tented, curved key-well keyboard.
2+
The [Dactyl ManuForm Carbonfet](https://github.com/carbonfet/dactyl-manuform) is a handwired, split bodied, tented, curved keywell keyboard.
33
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.
44

55
![White](https://i.imgur.com/0ugz1C9.jpg)
6-
*Dactyl Manuform Carbonfet 5x6 variant*
6+
*Dactyl ManuForm Carbonfet 5x6 variant*
77

88
## Variants
9-
Dactyl Manuform Carbonfets are built in variations that cater for different row and column counts.
9+
Dactyl ManuForm Carbonfets are built in variations that cater for different row and column counts.
1010
Variants are denoted as `RowCount`*x*`ColumnCount` and share the common configuration of:
11-
- The finger key-well bottom row has 2 keys; 1 each in ring and middle columns.
11+
- The finger keywell bottom row has 2 keys; 1 each in ring and middle columns.
1212
Exception to this rule is the `5x7` variant that has two additional keys in this row.
13-
- 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.
13+
- 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.
1414

1515
### Row
1616
| Count | Description |
1717
| ----- | -------------------------------------------------------------------------------------------------------------------------- |
18-
| 4 | Three rows, typically for alphabet and some punctuation characters, with two keys in bottom row of finger key-well section |
18+
| 4 | Three rows, typically for alphabet and some punctuation characters, with two keys in bottom row of finger keywell section |
1919
| 5 | As *4 rows* with number row above |
2020
| 6 | As *5 rows* with function row above |
2121

@@ -27,11 +27,11 @@ Variants are denoted as `RowCount`*x*`ColumnCount` and share the common configur
2727
| 7 | As *6 columns* with either an additional index finger column (`5x7`) or additional pinky column (`6x7`) |
2828

2929
## Extended Bottom Row
30-
Further to this board's customisable ethos, the bottom row of the finger key-well can be extended, outward, from the default two keys.
30+
Further to this board's customizable ethos, the bottom row of the finger keywell can be extended, outward, from the default two keys.
3131

3232
*Note: This does not apply to the `5x7` variant, as its bottom row is already extended*
3333

34-
To accomodate this, in files of chosen variant:
34+
To accommodate this, in files of chosen variant:
3535

3636
### `kb.py`
3737
`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:
4242
### `main.py`
4343
`keyboard.keymap` element: For each layer, append with keycodes in the respective extended bottom row positions.
4444

45-
## KMk Specifics
46-
Extentions enabled by default:
45+
## KMK Specifics
46+
Extensions enabled by default:
4747
- [Layers](/docs/en/layers.md)
4848
- [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.
4949

0 commit comments

Comments
 (0)