aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat
-rw-r--r--keyboards/ares/readme.md41
-rw-r--r--keyboards/bfake/readme.md43
-rw-r--r--keyboards/coseyfannitutti/discipline/readme.md10
-rw-r--r--keyboards/donutcables/budget96/readme.md42
-rw-r--r--keyboards/eve/meteor/readme.md40
-rw-r--r--keyboards/exclusive/e6v2/le_bmc/readme.md41
-rw-r--r--keyboards/exclusive/e6v2/oe_bmc/readme.md41
-rw-r--r--keyboards/exent/readme.md8
-rw-r--r--keyboards/facew/readme.md40
-rw-r--r--keyboards/ft/mars80/readme.md35
-rw-r--r--keyboards/gray_studio/hb85/readme.md37
-rw-r--r--keyboards/jc65/v32a/readme.md25
-rw-r--r--keyboards/jj40/README.md79
-rw-r--r--keyboards/jj4x4/README.md68
-rw-r--r--keyboards/jj50/README.md84
-rw-r--r--keyboards/kbdfans/kbdpad/mk1/readme.md40
-rw-r--r--keyboards/leeku/finger65/readme.md14
-rw-r--r--keyboards/mechmini/v1/README.md80
-rw-r--r--keyboards/mehkee96/readme.md37
-rw-r--r--keyboards/mt40/readme.md21
-rw-r--r--keyboards/panc60/readme.md43
-rw-r--r--keyboards/pearl/readme.md43
-rw-r--r--keyboards/percent/canoe/readme.md37
-rw-r--r--keyboards/percent/skog/README.md42
-rw-r--r--keyboards/percent/skog_lite/readme.md43
-rw-r--r--keyboards/singa/readme.md44
-rw-r--r--keyboards/tgr/alice/readme.md41
-rw-r--r--keyboards/tgr/jane/readme.md42
-rw-r--r--keyboards/unikorn/readme.md58
-rw-r--r--keyboards/winkeyless/bface/README.md41
-rw-r--r--keyboards/winkeyless/bmini/readme.md38
-rw-r--r--keyboards/winkeyless/bminiex/readme.md10
-rw-r--r--keyboards/ymd75/README.md84
-rw-r--r--keyboards/ymd96/readme.md66
-rw-r--r--keyboards/ymdk/bface/README.md46
-rw-r--r--keyboards/ymdk_np21/README.md16
36 files changed, 275 insertions, 1245 deletions
diff --git a/keyboards/ares/readme.md b/keyboards/ares/readme.md
index 338113a13..376cee437 100644
--- a/keyboards/ares/readme.md
+++ b/keyboards/ares/readme.md
@@ -1,42 +1,17 @@
1lSJ Ares 1# lSJ Ares
2========
3 2
4Keyboard Maintainer: QMK Community 3* Keyboard Maintainer: QMK Community
5Hardware Supported: LSJ Ares PCB 4* Hardware Supported: LSJ Ares PCB
6Hardware Availability: https://geekhack.org/index.php?topic=93146.0 5* Hardware Availability: <https://geekhack.org/index.php?topic=93146.0>
7 6
8Make example for this keyboard (after setting up your build environment): 7Make example for this keyboard (after setting up your build environment):
9 8
10 make ares:default 9 make ares:default
11 10
12Flashing 11Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
13 12
14ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods. 13 make ares:default:flash
15 14
16Windows: 15**Reset Key**: Hold down the *left control* key while plugging in the keyboard.
171. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
182. Place your keyboard into reset by holding the left control key and plugging the cable in.
193. Press the `Find Device` button and ensure that your keyboard is found.
204. Press the `Open .hex File` button and locate the `.hex` file you created.
215. Press the `Flash Device` button and wait for the process to complete.
22 16
23macOS: 17See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
241. Install homebrew by typing the following:
25 ```
26 /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
27 ```
282. Install `crosspack-avr`.
29 ```
30 brew cask install crosspack-avr
31 ```
323. Install the following packages:
33 ```
34 brew install python
35 brew install pyusb
36 brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
37
384. Place your keyboard into reset.
395. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file.
40
41
42See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information.
diff --git a/keyboards/bfake/readme.md b/keyboards/bfake/readme.md
index 1ccc25f2d..df319cd7c 100644
--- a/keyboards/bfake/readme.md
+++ b/keyboards/bfake/readme.md
@@ -1,44 +1,17 @@
1B.fake 1# B.fake
2========
3 2
4A 60% keyboard with RGB. The B.fake pcb is a copy of the B.face PCB sold by [winkeyless](https://winkeyless.kr/). However, the switch matrix is actually the same as the [FaceW](https://github.com/qmk/qmk_firmware/tree/master/keyboards/facew), a ps2avr PCB sold on [mechanicalkeyboards.com](https://mechanicalkeyboards.com/). 3A 60% keyboard with RGB. The B.fake pcb is a copy of the B.face PCB sold by [winkeyless](https://winkeyless.kr/). However, the switch matrix is actually the same as the [FaceW](https://github.com/qmk/qmk_firmware/tree/master/keyboards/facew), a ps2avr PCB sold on [mechanicalkeyboards.com](https://mechanicalkeyboards.com/).
5 4
6Keyboard Maintainer: QMK Community 5* Keyboard Maintainer: QMK Community
7Hardware Supported: B.fake PCB 6* Hardware Supported: B.fake PCB
8Hardware Availability: https://www.aliexpress.com/store/product/bface-60-RGB-underground-copy-pcb-from-china-gh60-pcb-Customize-keyboard-PCB/2230037_32731084597.html 7* Hardware Availability: <https://www.aliexpress.com/store/product/bface-60-RGB-underground-copy-pcb-from-china-gh60-pcb-Customize-keyboard-PCB/2230037_32731084597.html>
9 8
10Make example for this keyboard (after setting up your build environment): 9Make example for this keyboard (after setting up your build environment):
11 10
12 make bfake:default 11 make bfake:default
13 12
14Flashing 13Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
15 14
16ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods. 15 make bfake:default:flash
17 16
18Windows: 17See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
191. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
202. Place your keyboard into reset.
213. Press the `Find Device` button and ensure that your keyboard is found.
224. Press the `Open .hex File` button and locate the `.hex` file you created.
235. Press the `Flash Device` button and wait for the process to complete.
24
25macOS:
261. Install homebrew by typing the following:
27 ```
28 /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
29 ```
302. Install `crosspack-avr`.
31 ```
32 brew cask install crosspack-avr
33 ```
343. Install the following packages:
35 ```
36 brew install python
37 brew install pyusb
38 brew install --HEAD`https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
39
404. Place your keyboard into reset.
415. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file.
42
43
44See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information.
diff --git a/keyboards/coseyfannitutti/discipline/readme.md b/keyboards/coseyfannitutti/discipline/readme.md
index d11f1724f..d850151d1 100644
--- a/keyboards/coseyfannitutti/discipline/readme.md
+++ b/keyboards/coseyfannitutti/discipline/readme.md
@@ -4,12 +4,16 @@
4 4
5A 65% keyboard that can be assembled with only through hole components, including usb type-c 5A 65% keyboard that can be assembled with only through hole components, including usb type-c
6 6
7Keyboard Maintainer: [coseyfannitutti](https://github.com/coseyfannitutti) 7* Keyboard Maintainer: [coseyfannitutti](https://github.com/coseyfannitutti)
8Hardware Supported: DISCIPLINE, atmega32a 8* Hardware Supported: DISCIPLINE, atmega32a
9Hardware Availability: [cftkb.com](http://www.cftkb.com), [GitHub](https://github.com/coseyfannitutti/discipline) 9* Hardware Availability: [cftkb.com](http://www.cftkb.com), [GitHub](https://github.com/coseyfannitutti/discipline)
10 10
11Make example for this keyboard (after setting up your build environment): 11Make example for this keyboard (after setting up your build environment):
12 12
13 make coseyfannitutti/discipline:default 13 make coseyfannitutti/discipline:default
14 14
15Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
16
17 make coseyfannitutti/discipline:default:flash
18
15See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). 19See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
diff --git a/keyboards/donutcables/budget96/readme.md b/keyboards/donutcables/budget96/readme.md
index c83040360..11c49b983 100644
--- a/keyboards/donutcables/budget96/readme.md
+++ b/keyboards/donutcables/budget96/readme.md
@@ -2,44 +2,18 @@
2 2
396 key atmega32a keyboard. 396 key atmega32a keyboard.
4 4
5Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin) 5* Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)
6Hardware Supported: Budget96 PCB 6* Hardware Supported: Budget96 PCB
7Hardware Availability: [DonutCables](https://donutcables.com/) 7* Hardware Availability: [DonutCables](https://donutcables.com/)
8 8
9Make example for this keyboard (after setting up your build environment): 9Make example for this keyboard (after setting up your build environment):
10 10
11 make donutcables/budget96:default 11 make donutcables/budget96:default
12 12
13Flashing 13Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
14 14
15**Reset Key:** Hold down the key located at `K00`, commonly programmed as left control while plugging in the keyboard. 15 make donutcables/budget96:default:flash
16 16
17ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods. 17**Reset Key**: Hold down the key located at *K00*, commonly programmed as *left control* while plugging in the keyboard.
18
19Windows:
201. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
212. Place your keyboard into reset.
223. Press the `Find Device` button and ensure that your keyboard is found.
234. Press the `Open .hex File` button and locate the `.hex` file you created.
245. Press the `Flash Device` button and wait for the process to complete.
25
26macOS:
271. Install homebrew by typing the following:
28 ```
29 /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
30 ```
312. Install `crosspack-avr`.
32 ```
33 brew cask install crosspack-avr
34 ```
353. Install the following packages:
36 ```
37 brew install python3
38 pip3 install pyusb
39 brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
40 ```
41
424. Place your keyboard into reset.
435. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file.
44 18
45See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). 19See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
diff --git a/keyboards/eve/meteor/readme.md b/keyboards/eve/meteor/readme.md
index 8e933c09d..28884156e 100644
--- a/keyboards/eve/meteor/readme.md
+++ b/keyboards/eve/meteor/readme.md
@@ -2,50 +2,20 @@
2 2
360% PCB with Function Row 360% PCB with Function Row
4 4
5 5* Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)
6Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin) 6* Hardware Supported: EVE Meteor
7Hardware Supported: EVE Meteor 7* Hardware Availability: [zFrontier](https://en.zfrontier.com/products/eve-meteor)
8Hardware Availability: [zFrontier](https://en.zfrontier.com/products/eve-meteor)
9
10 8
11Make example for this keyboard (after setting up your build environment): 9Make example for this keyboard (after setting up your build environment):
12 10
13 make eve/meteor:default 11 make eve/meteor:default
14 12
15Flashing 13Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
16 14
17ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods. 15 make eve/meteor:default:flash
18 16
19**Reset Key:** Short the two holes labeled `FW_JP` underneath the PCB, beside the Tab key while plugging in the keyboard. 17**Reset Key:** Short the two holes labeled `FW_JP` underneath the PCB, beside the Tab key while plugging in the keyboard.
20 18
21Do not confuse this with the LED holes of the switch in the `Tab` position. `FW_JP` is not reachable from the top as the plate blocks access to it. 19Do not confuse this with the LED holes of the switch in the `Tab` position. `FW_JP` is not reachable from the top as the plate blocks access to it.
22 20
23It is recommended to program a `RESET` key in your keymap.
24
25Windows:
261. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
272. Place your keyboard into reset.
283. Press the `Find Device` button and ensure that your keyboard is found.
294. Press the `Open .hex File` button and locate the `.hex` file you created.
305. Press the `Flash Device` button and wait for the process to complete.
31
32macOS:
331. Install homebrew by typing the following:
34 ```
35 /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
36 ```
372. Install `crosspack-avr`.
38 ```
39 brew cask install crosspack-avr
40 ```
413. Install the following packages:
42 ```
43 brew install python3
44 pip3 install pyusb
45 brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
46 ```
474. Place your keyboard into reset.
485. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file.
49
50
51See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). 21See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
diff --git a/keyboards/exclusive/e6v2/le_bmc/readme.md b/keyboards/exclusive/e6v2/le_bmc/readme.md
index 4dc8e6ef5..561560a3e 100644
--- a/keyboards/exclusive/e6v2/le_bmc/readme.md
+++ b/keyboards/exclusive/e6v2/le_bmc/readme.md
@@ -2,43 +2,18 @@
2 2
3These docs are for the BMC version of the E6-V2 PCB sold during Round 2 which has an atmega32a microcontroller. Please do not flash this `.hex` file on your atmega32u4 equipped E6-V2 or your E6V2 BMC from Round 1. 3These docs are for the BMC version of the E6-V2 PCB sold during Round 2 which has an atmega32a microcontroller. Please do not flash this `.hex` file on your atmega32u4 equipped E6-V2 or your E6V2 BMC from Round 1.
4 4
5Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin) 5* Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)
6Hardware Supported: ps2avrgb E6-V2 with atmega32a microcontroller 6* Hardware Supported: ps2avrgb E6-V2 with atmega32a microcontroller
7Hardware Availability: [geekhack.org/index.php?topic=90787.0](https://geekhack.org/index.php?topic=90787.0) 7* Hardware Availability: [geekhack.org/index.php?topic=90787.0](https://geekhack.org/index.php?topic=90787.0)
8 8
9Make example for this keyboard (after setting up your build environment): 9Make example for this keyboard (after setting up your build environment):
10 10
11 make exclusive/e6v2/le_bmc:default 11 make exclusive/e6v2/le_bmc:default
12 12
13Flashing 13Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
14 14
15ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods. 15 make exclusive/e6v2/le_bmc:default:flash
16 16
17**Reset Key:** Hold down the key located at `K00`, commonly programmed as left control while plugging in the keyboard. 17**Reset Key**: Hold down the key located at *K00*, commonly programmed as *left control* while plugging in the keyboard.
18
19Windows:
201. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
212. Place your keyboard into reset.
223. Press the `Find Device` button and ensure that your keyboard is found.
234. Press the `Open .hex File` button and locate the `.hex` file you created.
245. Press the `Flash Device` button and wait for the process to complete.
25
26macOS:
271. Install homebrew by typing the following:
28 ```
29 /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
30 ```
312. Install `crosspack-avr`.
32 ```
33 brew cask install crosspack-avr
34 ```
353. Install the following packages:
36 ```
37 brew install python3
38 pip3 install pyusb
39 brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
40 ```
414. Place your keyboard into reset.
425. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file.
43 18
44See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). 19See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
diff --git a/keyboards/exclusive/e6v2/oe_bmc/readme.md b/keyboards/exclusive/e6v2/oe_bmc/readme.md
index a386abf6c..cd6da0ff0 100644
--- a/keyboards/exclusive/e6v2/oe_bmc/readme.md
+++ b/keyboards/exclusive/e6v2/oe_bmc/readme.md
@@ -2,43 +2,18 @@
2 2
3These docs are for the BMC version of the E6-V2 PCB sold during Round 1 which has an atmega32a microcontroller. Please do not flash this `.hex` file on your atmega32u4 equipped E6-V2 or your E6V2 BMC from Round 2. 3These docs are for the BMC version of the E6-V2 PCB sold during Round 1 which has an atmega32a microcontroller. Please do not flash this `.hex` file on your atmega32u4 equipped E6-V2 or your E6V2 BMC from Round 2.
4 4
5Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin) 5* Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)
6Hardware Supported: ps2avrgb E6-V2 with atmega32a microcontroller 6* Hardware Supported: ps2avrgb E6-V2 with atmega32a microcontroller
7Hardware Availability: [geekhack.org/index.php?topic=90787.0](https://geekhack.org/index.php?topic=90787.0) 7* Hardware Availability: [geekhack.org/index.php?topic=90787.0](https://geekhack.org/index.php?topic=90787.0)
8 8
9Make example for this keyboard (after setting up your build environment): 9Make example for this keyboard (after setting up your build environment):
10 10
11 make exclusive/e6v2/oe_bmc:default 11 make exclusive/e6v2/oe_bmc:default
12 12
13Flashing 13Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
14 14
15ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods. 15 make exclusive/e6v2/oe_bmc:default:flash
16 16
17**Reset Key:** Hold down the key located at `K00`, commonly programmed as left control while plugging in the keyboard. 17**Reset Key**: Hold down the key located at *K00*, commonly programmed as *left control* while plugging in the keyboard.
18
19Windows:
201. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
212. Place your keyboard into reset.
223. Press the `Find Device` button and ensure that your keyboard is found.
234. Press the `Open .hex File` button and locate the `.hex` file you created.
245. Press the `Flash Device` button and wait for the process to complete.
25
26macOS:
271. Install homebrew by typing the following:
28 ```
29 /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
30 ```
312. Install `crosspack-avr`.
32 ```
33 brew cask install crosspack-avr
34 ```
353. Install the following packages:
36 ```
37 brew install python3
38 pip3 install pyusb
39 brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
40
414. Place your keyboard into reset.
425. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file.
43 18
44See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). 19See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
diff --git a/keyboards/exent/readme.md b/keyboards/exent/readme.md
index 08807eda5..a98eff5f0 100644
--- a/keyboards/exent/readme.md
+++ b/keyboards/exent/readme.md
@@ -2,9 +2,9 @@
2 2
365% custom keyboard with large bezels. 365% custom keyboard with large bezels.
4 4
5Keyboard Maintainer: [mechmerlin](https://github.com/mechmerlin) 5* Keyboard Maintainer: [mechmerlin](https://github.com/mechmerlin)
6Hardware Supported: Exent PCB 6* Hardware Supported: Exent PCB
7Hardware Availability: [Geekhack GB](https://geekhack.org/index.php?topic=87213.0) 7* Hardware Availability: [Geekhack GB](https://geekhack.org/index.php?topic=87213.0)
8 8
9Make example for this keyboard (after setting up your build environment): 9Make example for this keyboard (after setting up your build environment):
10 10
@@ -14,6 +14,6 @@ Flashing example for this keyboard ([after setting up the bootloadHID flashing e
14 14
15 make exent:default:flash 15 make exent:default:flash
16 16
17**Reset Key**: Hold down the key located at `k0d`, commonly programmed as Backspace while plugging in the keyboard. 17**Reset Key**: Hold down the key located at `k0d`, commonly programmed as *Backspace* while plugging in the keyboard.
18 18
19See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). 19See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
diff --git a/keyboards/facew/readme.md b/keyboards/facew/readme.md
index b749d18d2..a852a4f46 100644
--- a/keyboards/facew/readme.md
+++ b/keyboards/facew/readme.md
@@ -4,44 +4,18 @@ A 60% no frills keyboard.
4 4
5The FaceW is a special run of the WKL B.Face sourced from Sprit that doesn't have underglow RGB LEDs but does have in switch LEDs. Also unlike the B.Face, it is based on ps2avru instead of ps2avrGB. It is designed and manufactured in Korea. 5The FaceW is a special run of the WKL B.Face sourced from Sprit that doesn't have underglow RGB LEDs but does have in switch LEDs. Also unlike the B.Face, it is based on ps2avru instead of ps2avrGB. It is designed and manufactured in Korea.
6 6
7Keyboard Maintainer: [MechMerlin](www.github.com/mechmerlin) 7* Keyboard Maintainer: [MechMerlin](www.github.com/mechmerlin)
8Hardware Supported: FaceW Sprit Edition PCB 8* Hardware Supported: FaceW Sprit Edition PCB
9Hardware Availability: https://mechanicalkeyboards.com/shop/index.php?l=product_detail&p=1352 9* Hardware Availability: <https://mechanicalkeyboards.com/shop/index.php?l=product_detail&p=1352>
10 10
11Make example for this keyboard (after setting up your build environment): 11Make example for this keyboard (after setting up your build environment):
12 12
13 make facew:default 13 make facew:default
14 14
15Flashing 15Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
16
17ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods.
18
19**Reset Key:** To put the FaceW into reset, hold `q` (`K01`) while plugging in.
20
21Windows:
221. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
232. Place your keyboard into reset.
243. Press the `Find Device` button and ensure that your keyboard is found.
254. Press the `Open .hex File` button and locate the `.hex` file you created.
265. Press the `Flash Device` button and wait for the process to complete.
27
28macOS:
291. Install homebrew by typing the following:
30 ```
31 /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
32 ```
332. Install `crosspack-avr`.
34 ```
35 brew cask install crosspack-avr
36 ```
373. Install the following packages:
38 ```
39 brew install python3
40 pip3 install pyusb
41 brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
42
434. Place your keyboard into reset.
445. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file.
45 16
17 make facew:default:flash
18
19**Reset Key**: Hold down the key located at *K01*, commonly programmed as *q* while plugging in the keyboard.
46 20
47See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). 21See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
diff --git a/keyboards/ft/mars80/readme.md b/keyboards/ft/mars80/readme.md
index 962275133..3d108300b 100644
--- a/keyboards/ft/mars80/readme.md
+++ b/keyboards/ft/mars80/readme.md
@@ -2,43 +2,18 @@
2 2
3TKL Keyboard with in switch backlight and RGB Underglow. 3TKL Keyboard with in switch backlight and RGB Underglow.
4 4
5Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin) 5* Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)
6Hardware Supported: Mars 8.0 PCB 6* Hardware Supported: Mars 8.0 PCB
7Hardware Availability: [Geekhack Group Buy](https://geekhack.org/index.php?topic=93723.0) 7* Hardware Availability: [Geekhack Group Buy](https://geekhack.org/index.php?topic=93723.0)
8 8
9Make example for this keyboard (after setting up your build environment): 9Make example for this keyboard (after setting up your build environment):
10 10
11 make ft/mars80:default 11 make ft/mars80:default
12 12
13Flashing 13Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
14 14
15ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods. 15 make ft/mars80:default:flash
16 16
17**Reset Key:** Hold down the key located at `K00`, commonly programmed as `Pause/Break` while plugging in the keyboard. 17**Reset Key:** Hold down the key located at `K00`, commonly programmed as `Pause/Break` while plugging in the keyboard.
18 18
19Windows:
201. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
212. Place your keyboard into reset.
223. Press the `Find Device` button and ensure that your keyboard is found.
234. Press the `Open .hex File` button and locate the `.hex` file you created.
245. Press the `Flash Device` button and wait for the process to complete.
25
26macOS:
271. Install homebrew by typing the following:
28 ```
29 /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
30 ```
312. Install `crosspack-avr`.
32 ```
33 brew cask install crosspack-avr
34 ```
353. Install the following packages:
36 ```
37 brew install python3
38 pip3 install pyusb
39 brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
40 ```
414. Place your keyboard into reset.
425. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file.
43
44See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). 19See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
diff --git a/keyboards/gray_studio/hb85/readme.md b/keyboards/gray_studio/hb85/readme.md
index c0c2fdf37..7e39f327c 100644
--- a/keyboards/gray_studio/hb85/readme.md
+++ b/keyboards/gray_studio/hb85/readme.md
@@ -4,45 +4,18 @@
4 4
5A Sony HitBit MSX Computer inspired Keyboard. 5A Sony HitBit MSX Computer inspired Keyboard.
6 6
7Keyboard Maintainer: [Felipe Coury](https://github.com/fcoury) 7* Keyboard Maintainer: [Felipe Coury](https://github.com/fcoury)
8Hardware Supported: Gray Studio HB85 8* Hardware Supported: Gray Studio HB85
9Hardware Availability: [Group buy](https://en.zfrontier.com/products/gray-hb85) finished 9* Hardware Availability: [Group buy](https://en.zfrontier.com/products/gray-hb85) finished
10 10
11Make example for this keyboard (after setting up your build environment): 11Make example for this keyboard (after setting up your build environment):
12 12
13 make gray_studio/hb85:default 13 make gray_studio/hb85:default
14 14
15Flashing 15Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
16 16
17ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods. 17 make gray_studio/hb85:default:flash
18 18
19**Reset Key:** Hold down the key located at `K00`, commonly programmed as F3 while plugging in the keyboard. 19**Reset Key:** Hold down the key located at `K00`, commonly programmed as F3 while plugging in the keyboard.
20 20
21Windows:
221. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
232. Place your keyboard into reset.
243. Press the `Find Device` button and ensure that your keyboard is found.
254. Press the `Open .hex File` button and locate the `.hex` file you created.
265. Press the `Flash Device` button and wait for the process to complete.
27
28macOS:
291. Install homebrew by typing the following:
30 ```
31 /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
32 ```
332. Install `crosspack-avr`.
34 ```
35 brew cask install crosspack-avr
36 ```
373. Install the following packages:
38 ```
39 brew install python3
40 pip3 install pyusb
41 brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
42
434. Place your keyboard into reset.
445. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file.
45
46**Please Note:** You will need to use the `EEP_RST` keycode first, followed by unplugging/replugging the board to get RGB underglow effects to work.
47
48See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). 21See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
diff --git a/keyboards/jc65/v32a/readme.md b/keyboards/jc65/v32a/readme.md
index 5027f8361..8a139ca66 100644
--- a/keyboards/jc65/v32a/readme.md
+++ b/keyboards/jc65/v32a/readme.md
@@ -1,32 +1,25 @@
1JC65 ps2avrGB 1# JC65
2=======
3 2
4![JC65](https://i.imgur.com/9cJ9UbX.jpg) 3![JC65](https://i.imgur.com/9cJ9UbX.jpg)
5 4
6A 65% keyboard with RGB 5A 65% keyboard with RGB
7 6
8Keyboard Maintainer: [Jason Barnachea](https://github.com/nautxx)
9
10Hardware Supported: JC65 rev.ps2avrgb
11
12Hardware Availability: [keyclack.com](https://keyclack.com/)
13
14The JC65 PCB actually has two revisions: A QMK native version, and a PS2AVRGB version. Jchan offered both PCBs as options during the M65-A Round 1 group buy, and were also available choices for the 65% acrylic case group buy. 7The JC65 PCB actually has two revisions: A QMK native version, and a PS2AVRGB version. Jchan offered both PCBs as options during the M65-A Round 1 group buy, and were also available choices for the 65% acrylic case group buy.
15 8
16Please note that there have been issues with QMK and PS2AVRGB boards. Random shutdowns and overheating have been reported. As of now, the cause has not been discovered.
17
18These docs are for the PS2AVRGB version of the PCB. More info on qmk.fm 9These docs are for the PS2AVRGB version of the PCB. More info on qmk.fm
19 10
11* Keyboard Maintainer: [Jason Barnachea](https://github.com/nautxx)
12* Hardware Supported: JC65 rev.ps2avrgb
13* Hardware Availability: [keyclack.com](https://keyclack.com/)
14
20Make example for this keyboard (after setting up your build environment): 15Make example for this keyboard (after setting up your build environment):
21 16
22 make jc65/v32a:default 17 make jc65/v32a:default
23
24Flash example for this keyboard:
25 18
26 bootloadHID -r jc65_v32a_default.hex 19Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
27 20
28Flashing on Windows can be accomplished by downloading [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash) 21 make jc65/v32a:default:flash
29 22
30To put the PS2AVRGB board into reset, hold down the left control key while plugging in the keyboard. 23**Reset Key**: Hold down the key commonly programmed as *left control* while plugging in the keyboard.
31 24
32See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. \ No newline at end of file 25See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
diff --git a/keyboards/jj40/README.md b/keyboards/jj40/README.md
index 7d3612554..5f4d2c8a9 100644
--- a/keyboards/jj40/README.md
+++ b/keyboards/jj40/README.md
@@ -4,81 +4,18 @@
4 4
5A compact 40% (12x4) ortholinear keyboard kit made and KPRepublic on AliExpress. 5A compact 40% (12x4) ortholinear keyboard kit made and KPRepublic on AliExpress.
6 6
7Keyboard Maintainer: [QMK Community](https://github.com/qmk) 7* Keyboard Maintainer: [QMK Community](https://github.com/qmk)
8Hardware Supported: Atmega32A 8* Hardware Supported: Atmega32A
9Hardware Availability: [AliExpress](https://www.aliexpress.com/store/product/jj40-Custom-Mechanical-Keyboard-40-PCB-programmed-40-planck-layouts-bface-firmware-gh40/3034003_32828781103.html) 9* Hardware Availability: [AliExpress](https://www.aliexpress.com/store/product/jj40-Custom-Mechanical-Keyboard-40-PCB-programmed-40-planck-layouts-bface-firmware-gh40/3034003_32828781103.html)
10 10
11Make example for this keyboard (after setting up your build environment): 11Make example for this keyboard (after setting up your build environment):
12 12
13 make jj40:default:program 13 make jj40:default
14 14
15See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. 15Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
16 16
17Note that this is a complete replacement for the firmware, so you won't be 17 make jj40:default:flash
18using Bootmapper Client to change any keyboard settings, since not all the
19USB report options are supported.
20 18
21In addition you may need the AVR toolchain and `bootloadHID` ([GitHub repo](https://github.com/whiteneon/bootloadHID)) for flashing: 19**Reset Key**: Hold down the *Top Right Key* key, commonly programmed as *Backspace* while plugging in the keyboard.
22 20
23For macOS: 21See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
24```
25$ brew cask install crosspack-avr
26$ brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
27```
28
29For Linux:
30```
31$ sudo apt install libusb-dev
32$ wget https://www.obdev.at/downloads/vusb/bootloadHID.2012-12-08.tar.gz
33$ tar -xzf bootloadHID.2012-12-08.tar.gz
34$ cd bootloadHID.2012-12-08/commandline
35$ make
36$ sudo cp bootloadHID /usr/bin
37```
38
39In order to use the `././util/atmega32a_program.py` script, which can reboot the board into
40the bootloader, you'll need Python 2 with PyUSB installed:
41
42```
43$ pip install pyusb
44```
45
46If you prefer (or are having issues with a `program` flash), you can just build it (`make jj40:<keymap-name>` and flash the firmware (`.hex` file) directly with
47`bootloadHID` if you boot the board while holding down `Backspace` (`Top Right Key`) to keep it
48in the bootloader:
49
50```
51$ make jj40
52$ bootloadHID -r jj40_default.hex
53```
54
55For Windows 10:
56Windows sometimes doesn't recognize the jj40. The easiest way of flashing a new layout is probably using [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
571. Go to Windows Device Manager and find the keyboard (plug it in while holding down `Backspace` (`Top Right Key`)). It can be found under Human Interface Devices or under Keyboards.
582. Go to properties and the Details tab to find the hardware ID. You want the VID and the PID (code after the underscore). Plug them into HIDBootFlash and hit Find Device.
593. Use `make jj40:<keymap-name>` to generate the .hex file in the qmk basis folder. Select the .hex file in HIDBootFlash and press Flash Device.
60
61
62## Troubleshooting
63
641. Try plugging the board in while pressing `Backspace` (`Top Right Key`). This will force it
65 to boot only the bootloader without loading the firmware. Once this is
66 done, just reflash the board with the original firmware.
672. Sometimes USB hubs can act weird, so try connecting the board directly
68 to your computer or plugging/unplugging the USB hub.
693. If you get an error such as "Resource Unavailable" when attemting to flash
70 on Linux, you may want to compile and run `tools/usb_detach.c`. See `tools/README.md`
71 for more info.
72
73## Recovery
74If you flash a bad hex (e.g. you have a V1 board without RGB and compile/flash blindly without editing your rules.mk), your jj40 is now semi-bricked and you're stuck unless you have access to an ISP. The [ISP Flashing Guide](https://docs.qmk.fm/#/isp_flashing_guide) contains very good (but somewhat generalized) information. However, the instructions below should get you up and running provided you have an Arduino or clone.
75
76### Arduino Setup
771. Upload the ArduinoISP sketch onto your Arduino board (https://www.arduino.cc/en/Tutorial/ArduinoISP).
782. Wire the Arduino to the jj40. Match the data pins on the Arduino to those on the jj40. "RST" usually goes to D10 on the Arduino. I didn't need a capacitor when using my Uno.
79![Imgur](https://i.imgur.com/oLWJOkQ.jpg)
803. Get a working bootloader from https://blog.winkeyless.kr/m/152. The file is called "main.hex" from the archive called "ps2avrGB_bootloader_161215.zip" Copy "main.hex" to your qmk folder.
814. Burn the bootloader with the following command
82` avrdude -b 19200 -c avrisp -p atmega32 -v -e -U hfuse:w:0xD0:m -U lfuse:w:0x0F:m -U flash:w:main.hex:i -P comPORT`
83Change `comPORT` to whatever port is used by the Arduino (e.g. `com11` in Windows or `/dev/ttyACM0` in Linux). Use Device Manager in Windows to find the port being used. Use `ls /dev/tty*` in Linux.
845. If this process is successful, you should now be able to upload normally.
diff --git a/keyboards/jj4x4/README.md b/keyboards/jj4x4/README.md
index 29dc2605d..a7c93c930 100644
--- a/keyboards/jj4x4/README.md
+++ b/keyboards/jj4x4/README.md
@@ -2,70 +2,20 @@
2 2
3![jj4x4](https://cdn.shopify.com/s/files/1/2711/4238/products/JJ4x4case-1_1024x1024.jpg?v=1532325339) 3![jj4x4](https://cdn.shopify.com/s/files/1/2711/4238/products/JJ4x4case-1_1024x1024.jpg?v=1532325339)
4 4
5A 4x4 keypad kit made and KPRepublic on AliExpress. This is a chopped off version of the jj40 with rearranged keys. 5A 4x4 keypad kit made and KPRepublic on AliExpress. This is a chopped off version of the jj40 with rearranged keys.
6 6
7Keyboard Maintainer: [QMK Community](https://github.com/qmk) 7* Keyboard Maintainer: [QMK Community](https://github.com/qmk)
8Hardware Supported: Atmega32A 8* Hardware Supported: Atmega32A
9Hardware Availability: [AliExpress](https://www.aliexpress.com/item/jj4x4-jj4X4-16-keys-Custom-Mechanical-Keyboard-PCB-programmed-numpad-layouts-bface-firmware-with-rgb-bottom/32901955446.html?spm=2114.search0104.3.7.3ebf431ae1d9ic&ws_ab_test=searchweb0_0,searchweb201602_4_10065_10130_10068_10547_319_317_10548_10545_10696_453_10084_454_10083_433_10618_431_10307_537_536_10902_10059_10884_10887_321_322_10103,searchweb201603_6,ppcSwitch_0&algo_expid=9d1891dd-80af-4793-a889-5a62e1fdfdd8-1&algo_pvid=9d1891dd-80af-4793-a889-5a62e1fdfdd8&transAbTest=ae803_5) 9* Hardware Availability: [AliExpress](https://www.aliexpress.com/item/jj4x4-jj4X4-16-keys-Custom-Mechanical-Keyboard-PCB-programmed-numpad-layouts-bface-firmware-with-rgb-bottom/32901955446.html)
10 10
11Make example for this keyboard (after setting up your build environment): 11Make example for this keyboard (after setting up your build environment):
12 12
13 make jj4x4:default:program 13 make jj4x4:default
14 14
15See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. 15Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
16 16
17Note that this is a complete replacement for the firmware, so you won't be 17 make jj4x4:default:flash
18using Bootmapper Client to change any keyboard settings, since not all the
19USB report options are supported.
20 18
21In addition you may need the AVR toolchain and `bootloadHID` ([GitHub repo](https://github.com/whiteneon/bootloadHID)) for flashing: 19**Reset Key**: Hold down the key located at *K00*, commonly programmed as *8* while plugging in the keyboard.
22 20
23For macOS: 21See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
24```
25$ brew cask install crosspack-avr
26$ brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
27```
28
29For Linux:
30```
31$ sudo apt install libusb-dev
32$ wget https://www.obdev.at/downloads/vusb/bootloadHID.2012-12-08.tar.gz
33$ tar -xzf bootloadHID.2012-12-08.tar.gz
34$ cd bootloadHID.2012-12-08/commandline
35$ make
36$ sudo cp bootloadHID /usr/bin
37```
38
39In order to use the `./util/atmega32a_program.py` script, which can reboot the board into
40the bootloader, you'll need Python 2 with PyUSB installed:
41
42```
43$ pip install pyusb
44```
45
46If you prefer (or are having issues with a `program` flash), you can just build it (`make jj40:<keymap-name>` and flash the firmware (`.hex` file) directly with
47`bootloadHID` if you boot the board while holding down `8` (second from top, second from left, with usb plug is at the top) to keep it
48in the bootloader:
49
50```
51$ make jj40
52$ bootloadHID -r jj4x4_default.hex
53```
54
55For Windows 10:
56Windows sometimes doesn't recognize the jj4x4. The easiest way of flashing a new layout is probably using [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
571. Go to Windows Device Manager and find the keyboard (plug it in while holding down `8` (second from top, second from left, with usb plug is at the top)). It can be found under Human Interface Devices or under Keyboards.
582. Go to properties and the Details tab to find the hardware ID. You want the VID and the PID (code after the underscore). Plug them into HIDBootFlash and hit Find Device.
593. Use `make jj4x4:<keymap-name>` to generate the .hex file in the qmk basis folder. Select the .hex file in HIDBootFlash and press Flash Device.
60
61
62## Troubleshooting
63
641. Try plugging the board in while pressing `8` (usb plug at top, second from top, second from left). This will force it
65 to boot only the bootloader without loading the firmware. Once this is
66 done, just reflash the board with the original firmware.
672. Sometimes USB hubs can act weird, so try connecting the board directly
68 to your computer or plugging/unplugging the USB hub.
693. If you get an error such as "Resource Unavailable" when attemting to flash
70 on Linux, you may want to compile and run `tools/usb_detach.c`. See `tools/README.md`
71 for more info.
diff --git a/keyboards/jj50/README.md b/keyboards/jj50/README.md
index f7b8acc64..2d3e711be 100644
--- a/keyboards/jj50/README.md
+++ b/keyboards/jj50/README.md
@@ -1,83 +1,19 @@
1JJ50 1# JJ50
2==========================
3 2
4This is a port of the QMK firmware for boards that are based on the 3A preonic-like board
5ps2avrGB firmware, like the [ps2avrGB keyboard](https://www.keyclack.com/product/gb-ps2avrgb/), for use on the JJ50, a preonic-like board.
6 4
7Most of the code was taken and amended from YMD96, which in itself was taken from ps2avrGB and amended by Andrew Novak. 5* Keyboard Maintainer: [Wayne K. Jones](github.com/WarmCatUK)
8 6* Hardware Supported: JJ50 with the ATmega32a chip.
9Note that this is a complete replacement for the firmware, so you won't be 7* Hardware Availability: [KPrepublic on AliExpress](https://www.aliexpress.com/item/jj50-v1-0-Custom-Mechanical-Keyboard-50-PCB-programmed-50-preonic-layouts-bface-firmware-with-rgb/32848915277.html)
10using Bootmapper Client to change any keyboard settings, since not all the
11USB report options are supported.
12
13Hardware Supported: JJ50 with the ATmega32a chip.
14Hardware Availability: [KPrepublic on AliExpress](https://www.aliexpress.com/item/jj50-v1-0-Custom-Mechanical-Keyboard-50-PCB-programmed-50-preonic-layouts-bface-firmware-with-rgb/32848915277.html)
15
16This version by [Wayne K. Jones](github.com/WarmCatUK).
17
18
19## Installing and Building
20 8
21Make example for this keyboard (after setting up your build environment): 9Make example for this keyboard (after setting up your build environment):
22 10
23``` 11 make jj50:default
24$ make jj50:default:program
25```
26It should detect the keyboard and set it to bootloader mode automatically, prior to flashing firmware.
27
28See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information.
29
30Note that this is a complete replacement for the firmware, so you won't be
31using Bootmapper Client to change any keyboard settings, since not all the
32USB report options are supported.
33In addition you may need the AVR toolchain and `bootloadHID` for flashing:
34
35```
36$ brew cask install crosspack-avr
37$ brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
38```
39
40In order to use the `././util/atmega32a_program.py` script, which can reboot the board into
41the bootloader, you'll need Python 2 with PyUSB installed:
42
43```
44$ pip install pyusb
45```
46
47If you prefer, you can just build it and flash the firmware directly with
48`bootloadHID` if you boot the board while holding down `Backspace` (`key below top right key`) to keep it
49in the bootloader:
50
51```
52$ make jj50
53$ bootloadHID -r jj50_default.hex
54```
55I dont use windows personally, but the following is from ymd96 regarding flashing the atmega32a:
56
57Since the JJ50 uses an ATmega32a chip instead of the 32u4, you need to download [HIDBootFlash v.1.0](http://vusb.wikidot.com/project:hidbootflash) for Windows. If anyone knows of a Linux/Mac bootflasher that works, edit this readme!
58On Windows, I use [MINGw](http://www.mingw.org/) to compile the keymaps. On Linux or OSX you can simply use the terminal.
59
60Once you have those two pieces of software:
61Build the keyboard with
62```
63$ make jj50:default
64```
65If you make your own layout, change the `default` word to whatever your layout is.
66
67And flash the compiled hex file with `HIDBootFlash`. Simply put the board in flashing mode by plugging it in while holding the key below the top right key, and click `find device`. Then you can specify the .hex file and flash it to the device.
68
69
70## Troubleshooting
71 12
721. Try plugging the board in while pressing `Backspace` (`Key below the top right key`). This will force it to boot only the bootloader without loading the firmware. Once this is done, just reflash the board with the original firmware. 13Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
732. Sometimes USB hubs can act weird, so try connecting the board directly to your computer or plugging/unplugging the USB hub.
743. If you get an error such as "Resource Unavailable" when attemting to flash on Linux, you may want to compile and run `tools/usb_detach.c`. See `tools/README.md` for more info.
754. I was occasionally finding that I wasn't flashing changes that I was making to my keymap. If that happens, remove the previous build and simply force rebuild by making with:
76```
77$ rm jj50_default.hex
78$ make -B jj50:default
79$ make -B jj50:default:program
80```
81 14
15 make jj50:default:flash
82 16
17**Reset Key**: Hold down the key `Backspace` (`Key below the top right key`) while plugging in the keyboard.
83 18
19See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
diff --git a/keyboards/kbdfans/kbdpad/mk1/readme.md b/keyboards/kbdfans/kbdpad/mk1/readme.md
index e808d8934..2424d4d4d 100644
--- a/keyboards/kbdfans/kbdpad/mk1/readme.md
+++ b/keyboards/kbdfans/kbdpad/mk1/readme.md
@@ -1,47 +1,19 @@
1# KBDPad MKI 1# KBDPad MKI
2 2
3Custom numpad. 3Custom numpad.
4
5Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)
6Hardware Supported: KBDPad MKI
7Hardware Availability: [KBDfans](https://kbdfans.com/products/kbdfans-pad-custom-mechanical-keyboard-diy-kit)
8 4
5* Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)
6* Hardware Supported: KBDPad MKI
7* Hardware Availability: [KBDfans](https://kbdfans.com/products/kbdfans-pad-custom-mechanical-keyboard-diy-kit)
9 8
10Make example for this keyboard (after setting up your build environment): 9Make example for this keyboard (after setting up your build environment):
11 10
12 make kbdfans/kbdpad/mk1:default 11 make kbdfans/kbdpad/mk1:default
13 12
14Flashing 13Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
15 14
16ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods. 15 make kbdfans/kbdpad/mk1:default:flash
17 16
18**Reset Key:** Hold down the key located at `K00`, commonly programmed as `0` while plugging in the keyboard. 17**Reset Key:** Hold down the key located at `K00`, commonly programmed as `0` while plugging in the keyboard.
19 18
20Windows:
211. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
222. Place your keyboard into reset.
233. Press the `Find Device` button and ensure that your keyboard is found.
244. Press the `Open .hex File` button and locate the `.hex` file you created.
255. Press the `Flash Device` button and wait for the process to complete.
26
27macOS:
281. Install homebrew by typing the following:
29 ```
30 /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
31 ```
322. Install `crosspack-avr`.
33 ```
34 brew cask install crosspack-avr
35 ```
363. Install the following packages:
37 ```
38 brew install python3
39 pip3 install pyusb
40 brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
41 ```
42
434. Place your keyboard into reset.
445. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file.
45
46
47See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). 19See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
diff --git a/keyboards/leeku/finger65/readme.md b/keyboards/leeku/finger65/readme.md
index c800f3af3..c27ce5d48 100644
--- a/keyboards/leeku/finger65/readme.md
+++ b/keyboards/leeku/finger65/readme.md
@@ -1,16 +1,16 @@
1# Leeku Finger65 PCB 1# Leeku Finger65
2
3**This PCB is not QMK ready by default**. If you want to use your Leeku Finger65 PCB with QMK, you **must** ISP Flash the Leeku PCB using the bootloader for the atmega32a that resides in the `util/` folder.
2 4
3* Keyboard Maintainer: [sidcarter](https://github.com/sidcarter) 5* Keyboard Maintainer: [sidcarter](https://github.com/sidcarter)
4* Hardware Supported: LeeKu Finger65 PCB, atmega32a 6* Hardware Supported: LeeKu Finger65 PCB, atmega32a
5 7
6* Make example for this keyboard (after setting up your build environment): 8Make example for this keyboard (after setting up your build environment):
7 9
8 make leeku/finger65:default 10 make leeku/finger65:default
9 11
10* This PCB is not QMK ready by default. If you want to use your Leeku Finger65 PCB with QMK, you must: 12Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
11 13
12 * ISP Flash the Leeku PCB using the bootloader for the atmega32a that resides in the `util/` folder 14 make leeku/finger65:default:flash
13 * Build and install [bootloadHID](https://www.obdev.at/products/vusb/bootloadhid.html) on your system
14 * You can then do a `make leeku/finger65:default:flash` to flash your PCB with QMK
15 15
16* See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). 16See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
diff --git a/keyboards/mechmini/v1/README.md b/keyboards/mechmini/v1/README.md
index 315349803..902948c24 100644
--- a/keyboards/mechmini/v1/README.md
+++ b/keyboards/mechmini/v1/README.md
@@ -1,83 +1,19 @@
1Mechmini V1 1# Mechmini V1
2===========
3 2
4A 40% ortholinear/staggered keyboard, that was originally bootmapper and can be ported to QMK following this readme. This version is no longer in production [More info on MECHKEYS](https://mechkeys.ca). 3A 40% ortholinear/staggered keyboard, that was originally bootmapper and can be ported to QMK following this readme. This version is no longer in production [More info on MECHKEYS](https://mechkeys.ca).
5 4
6Keyboard Maintainer: QMK Community 5* Keyboard Maintainer: QMK Community
7Hardware Supported: Mechmini 1 PCB 6* Hardware Supported: Mechmini 1 PCB
8Hardware Availability: Version 1 (Bootmapper) no longer in production [MECHKEYS](https://mechkeys.ca) 7* Hardware Availability: Version 1 (Bootmapper) no longer in production [MECHKEYS](https://mechkeys.ca)
9 8
10Make example for this keyboard (after setting up your build environment): 9Make example for this keyboard (after setting up your build environment):
11 10
12 make mechmini/v1:default 11 make mechmini/v1:default
13 12
14See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. 13Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
15 14
16## Mechmini Notes 15 make mechmini/v1:default:flash
17
18Note that this is a complete replacement for the firmware, so you won't be
19using Bootmapper Client to change any keyboard settings, since not all the
20USB report options are supported.
21
22## Installing
23
24First, install the requirements. These commands are for OSX, but all you
25need is the AVR toolchain and `bootloadHID` for flashing:
26
27```
28$ brew cask install crosspack-avr
29$ brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
30```
31
32In order to use the `./util/atmega32a_program.py` script, which can reboot the board into
33the bootloader, you'll need Python 2 with PyUSB installed:
34
35```
36$ pip install pyusb
37```
38
39Then, with the keyboard plugged in, simply run this command from the
40`qmk_firmware` directory:
41
42```
43$ make mechmini:program
44```
45
46If you prefer, you can just build it and flash the firmware directly with
47`bootloadHID` if you boot the board while holding down `L_Ctrl` to keep it
48in the bootloader:
49
50```
51$ make mechmini
52$ bootloadHID -r mechmini_default.hex
53```
54
55## Troubleshooting
56
57From my experience, it's really hard to brick these boards. But these
58tricks have been useful when it got stuck in a weird scenario.
59
601. Try plugging the board in while pressing `L_Ctrl`. This will force it
61 to boot only the bootloader without loading the firmware. Once this is
62 done, just reflash the board with the original firmware.
632. Sometimes USB hubs can act weird, so try connecting the board directly
64 to your computer or plugging/unplugging the USB hub.
653. If errors happen with
66`./tmk_core/common/avr/suspend.c` it is likely you implemented a RGB underglow sleep setting previously. Simply comment out the following code found under `void suspend_wakeup_init(void)`:
67```
68ifdef RGBLIGHT_ANIMATIONS
69 rgblight_timer_enable();
70 _delay_ms(50);
71 rgblight_set();
72#endif
73```
74So that the resulting code should know reflect:
75```
76/*#ifdef RGBLIGHT_ANIMATIONS
77 rgblight_timer_enable();
78 _delay_ms(50);
79 rgblight_set();
80#endif*/
81```
82 16
17**Reset Key**: Hold down the key commonly programmed as *L_Ctrl* while plugging in the keyboard.
83 18
19See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
diff --git a/keyboards/mehkee96/readme.md b/keyboards/mehkee96/readme.md
index a06f2e33e..ff1a6e201 100644
--- a/keyboards/mehkee96/readme.md
+++ b/keyboards/mehkee96/readme.md
@@ -4,43 +4,16 @@
4 4
596-key Keyboard from mehkee 596-key Keyboard from mehkee
6 6
7Keyboard Maintainer: [johanntang](https://github.com/johanntang) 7* Keyboard Maintainer: [johanntang](https://github.com/johanntang)
8Hardware Supported: mehkee96 8* Hardware Supported: mehkee96
9Hardware Availability: [mehkee, group buy closed](https://mehkee.com/products/96kee?variant=46912017423) 9* Hardware Availability: [mehkee, group buy closed](https://mehkee.com/products/96kee?variant=46912017423)
10 10
11Make example for this keyboard (after setting up your build environment): 11Make example for this keyboard (after setting up your build environment):
12 12
13 make mehkee96:default 13 make mehkee96:default
14 14
15Flashing 15Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
16
17ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods.
18
19Windows:
201. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
212. Place your keyboard into reset.
223. Press the `Find Device` button and ensure that your keyboard is found.
234. Press the `Open .hex File` button and locate the `.hex` file you created.
245. Press the `Flash Device` button and wait for the process to complete.
25
26macOS:
271. Install homebrew by typing the following:
28 ```
29 /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
30 ```
312. Install `crosspack-avr`.
32 ```
33 brew cask install crosspack-avr
34 ```
353. Install the following packages:
36 ```
37 brew install python
38 brew install pyusb
39 brew install --HEAD`https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
40 ```
41
424. Place your keyboard into reset.
435. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file.
44 16
17 make mehkee96:default:flash
45 18
46See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). 19See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
diff --git a/keyboards/mt40/readme.md b/keyboards/mt40/readme.md
index aba5fa0d0..5fc82d89a 100644
--- a/keyboards/mt40/readme.md
+++ b/keyboards/mt40/readme.md
@@ -1,16 +1,19 @@
1# MT40: An 40% Ortholinear Keyboard 1# MT40
2 2
3## Program 3[MT40](https://i.imgur.com/0opsDkt.jpg)
4 4
5`make mt40:default:program` 5A 40% Ortholinear Keyboard
6 6
7## Pictures 7* Keyboard Maintainer: QMK Community
8* Hardware Supported: MT40
9* Hardware Availability: <https://world.taobao.com/item/548335974877.htm?fromSite=main&spm=a312a.7700824.w4002-6810221593.51.670e68a08mRh69>
8 10
9[PCB](https://i.imgur.com/8BeeY07.jpg) 11Make example for this keyboard (after setting up your build environment):
10[Backview of the PCB](https://i.imgur.com/0opsDkt.jpg)
11[Board with Sleeve](https://i.imgur.com/44FhPU8.jpg)
12 12
13## Buy 13 make mt40:default
14 14
15https://world.taobao.com/item/548335974877.htm?fromSite=main&spm=a312a.7700824.w4002-6810221593.51.670e68a08mRh69 15Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
16 16
17 make mt40:default:flash
18
19See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
diff --git a/keyboards/panc60/readme.md b/keyboards/panc60/readme.md
index 3312a07ce..52dcc4cce 100644
--- a/keyboards/panc60/readme.md
+++ b/keyboards/panc60/readme.md
@@ -4,45 +4,18 @@
4 4
5The panc60 is a 60% PCB with backlight and rgb underglow. 5The panc60 is a 60% PCB with backlight and rgb underglow.
6 6
7Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin), [Jack Humbert](https://github.com/jackhumbert) 7* Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin), [Jack Humbert](https://github.com/jackhumbert)
8Hardware Supported: panc60 PCB 8* Hardware Supported: panc60 PCB
9Hardware Availability: [PANC Interactive](https://store.panc.co/product/panc60-60-pcb) 9* Hardware Availability: [PANC Interactive](https://store.panc.co/product/panc60-60-pcb)
10 10
11Make example for this keyboard (after setting up your build environment): 11Make example for this keyboard (after setting up your build environment):
12 12
13 make panc60:default 13 make panc60:default
14 14
15Flashing 15Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
16 16
17**Reset Key:** Hold down the key located at `K40`, commonly programmed as left control while plugging in the keyboard. 17 make panc60:default:flash
18 18
19ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods. 19**Reset Key**: Hold down the key located at *K40*, commonly programmed as *left control* while plugging in the keyboard.
20
21To put the panc60 into reset, hold left control while plugging in.
22
23Windows:
241. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
252. Place your keyboard into reset.
263. Press the `Find Device` button and ensure that your keyboard is found.
274. Press the `Open .hex File` button and locate the `.hex` file you created.
285. Press the `Flash Device` button and wait for the process to complete.
29
30macOS:
311. Install homebrew by typing the following:
32 ```
33 /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
34 ```
352. Install `crosspack-avr`.
36 ```
37 brew cask install crosspack-avr
38 ```
393. Install the following packages:
40 ```
41 brew install python3
42 pip3 install pyusb
43 brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
44
454. Place your keyboard into reset.
465. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file.
47 20
48See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). 21See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
diff --git a/keyboards/pearl/readme.md b/keyboards/pearl/readme.md
index c39d86cf3..1f78a5540 100644
--- a/keyboards/pearl/readme.md
+++ b/keyboards/pearl/readme.md
@@ -3,45 +3,18 @@
3Pearl 40% is a keyboard designed by Koobaczech. It uses an Atmel 3Pearl 40% is a keyboard designed by Koobaczech. It uses an Atmel
4ATMEGA32A MCU. 4ATMEGA32A MCU.
5 5
6Keyboard Maintainer: [Ethan Madden](https://github.com/jetpacktuxedo) 6* Keyboard Maintainer: [Ethan Madden](https://github.com/jetpacktuxedo)
7Hardware Supported: Pearl 7* Hardware Supported: Pearl
8Hardware Availability: [Geekhack Group Buy](https://geekhack.org/index.php?topic=92259.0) 8* Hardware Availability: [Geekhack Group Buy](https://geekhack.org/index.php?topic=92259.0)
9 9
10Make example for this keyboard (after setting up your build environment): 10Make example for this keyboard (after setting up your build environment):
11 11
12 make pearl:default 12 make pearl:default
13 13
14Flashing 14Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
15 15
16ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods. 16 make pearl:default:flash
17 17
18**Reset Key:** Hold down the key located at `K00`. 18**Reset Key**: Hold down the key located at *K00*, commonly programmed as *Esc* while plugging in the keyboard.
19
20Windows:
211. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
222. Place your keyboard into reset.
233. Press the `Find Device` button and ensure that your keyboard is found.
244. Press the `Open .hex File` button and locate the `.hex` file you created.
255. Press the `Flash Device` button and wait for the process to complete.
26
27macOS:
281. Install homebrew by typing the following:
29 ```
30 /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
31 ```
322. Install `crosspack-avr`.
33 ```
34 brew cask install crosspack-avr
35 ```
363. Install the following packages:
37 ```
38 brew install python3
39 pip3 install pyusb
40 brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
41 ```
424. Place your keyboard into reset.
435. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file.
44
45**Please Note:** You will need to use the `EEP_RST` keycode first, followed by unplugging/replugging the board to get RGB underglow effects to work.
46 19
47See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). 20See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
diff --git a/keyboards/percent/canoe/readme.md b/keyboards/percent/canoe/readme.md
index 45773e468..d8a496f26 100644
--- a/keyboards/percent/canoe/readme.md
+++ b/keyboards/percent/canoe/readme.md
@@ -2,43 +2,16 @@
2 2
3A 65% keyboard with some RGB 3A 65% keyboard with some RGB
4 4
5Keyboard Maintainer: QMK Community 5* Keyboard Maintainer: QMK Community
6Hardware Supported: Canoe 6* Hardware Supported: Canoe
7Hardware Availability: https://geekhack.org/index.php?topic=92418.0 7* Hardware Availability: <https://geekhack.org/index.php?topic=92418.0>
8 8
9Make example for this keyboard (after setting up your build environment): 9Make example for this keyboard (after setting up your build environment):
10 10
11 make percent/canoe:default 11 make percent/canoe:default
12 12
13Flashing 13Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
14
15ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods.
16
17Windows:
181. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
192. Place your keyboard into reset.
203. Press the `Find Device` button and ensure that your keyboard is found.
214. Press the `Open .hex File` button and locate the `.hex` file you created.
225. Press the `Flash Device` button and wait for the process to complete.
23
24macOS:
251. Install homebrew by typing the following:
26 ```
27 /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
28 ```
292. Install `crosspack-avr`.
30 ```
31 brew cask install crosspack-avr
32 ```
333. Install the following packages:
34 ```
35 brew install python3
36 pip3 install pyusb
37 brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
38 ```
39
404. Place your keyboard into reset.
415. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file.
42 14
15 make percent/canoe:default:flash
43 16
44See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). 17See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
diff --git a/keyboards/percent/skog/README.md b/keyboards/percent/skog/README.md
index 5b7dacd91..9f76110cd 100644
--- a/keyboards/percent/skog/README.md
+++ b/keyboards/percent/skog/README.md
@@ -1,45 +1,17 @@
1# Skog TKL 1# Skog TKL
2 2
3Keyboard Maintainer: QMK Community 3* Keyboard Maintainer: QMK Community
4Hardware Supported: Skog PCB 4* Hardware Supported: Skog PCB
5Hardware Availability: https://geekhack.org/index.php?topic=87953.0 5* Hardware Availability: <https://geekhack.org/index.php?topic=87953.0>
6 6
7Make example for this keyboard (after setting up your build environment): 7Make example for this keyboard (after setting up your build environment):
8 8
9 make percent/skog:default 9 make percent/skog:default
10 10
11Flashing 11Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
12 12
13ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods. 13 make percent/skog:default:flash
14 14
15**Reset Key:** Hold down the key located at `K00`, commonly programmed as Pause while plugging in the keyboard. 15**Reset Key**: Hold down the key located at *K00*, commonly programmed as *Pause* while plugging in the keyboard.
16 16
17Windows: 17See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
181. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
192. Place your keyboard into reset.
203. Press the `Find Device` button and ensure that your keyboard is found.
214. Press the `Open .hex File` button and locate the `.hex` file you created.
225. Press the `Flash Device` button and wait for the process to complete.
23
24macOS:
251. Install homebrew by typing the following:
26 ```
27 /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
28 ```
292. Install `crosspack-avr`.
30 ```
31 brew cask install crosspack-avr
32 ```
333. Install the following packages:
34 ```
35 brew install python3
36 pip3 install pyusb
37 brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
38 ```
39
404. Place your keyboard into reset.
415. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file.
42
43**Please Note:** You will need to use the `EEP_RST` keycode first, followed by unplugging/replugging the board to get RGB underglow effects to work.
44
45See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). \ No newline at end of file
diff --git a/keyboards/percent/skog_lite/readme.md b/keyboards/percent/skog_lite/readme.md
index 369129e86..72ca79725 100644
--- a/keyboards/percent/skog_lite/readme.md
+++ b/keyboards/percent/skog_lite/readme.md
@@ -2,47 +2,18 @@
2 2
3TKL Custom Keyboard. 3TKL Custom Keyboard.
4 4
5 5* Keyboard Maintainer: [mechmerlin](https://github.com/mechmerlin)
6Keyboard Maintainer: [mechmerlin](https://github.com/mechmerlin) 6* Hardware Supported: Skog Lite PCB
7Hardware Supported: Skog Lite PCB 7* Hardware Availability: [Kono Store](https://kono.store/products/skog-lite)
8Hardware Availability: [Kono Store](https://kono.store/products/skog-lite)
9
10 8
11Make example for this keyboard (after setting up your build environment): 9Make example for this keyboard (after setting up your build environment):
12 10
13 make percent/skog_lite:default 11 make percent/skog_lite:default
14 12
15Flashing 13Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
16 14
17ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods. 15 make percent/skog_lite:default:flash
18
19**Reset Key:** Hold down the key located at `K05`, commonly programmed as `F5` while plugging in the keyboard.
20
21Windows:
221. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
232. Place your keyboard into reset.
243. Press the `Find Device` button and ensure that your keyboard is found.
254. Press the `Open .hex File` button and locate the `.hex` file you created.
265. Press the `Flash Device` button and wait for the process to complete.
27
28macOS:
291. Install homebrew by typing the following:
30 ```
31 /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
32 ```
332. Install `crosspack-avr`.
34 ```
35 brew cask install crosspack-avr
36 ```
373. Install the following packages:
38 ```
39 brew install python3
40 pip3 install pyusb
41 brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
42 ```
43
444. Place your keyboard into reset.
455. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file.
46 16
17**Reset Key**: Hold down the key located at *K05*, commonly programmed as *F5* while plugging in the keyboard.
47 18
48See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). 19See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
diff --git a/keyboards/singa/readme.md b/keyboards/singa/readme.md
index faeb816ec..e3b87092e 100644
--- a/keyboards/singa/readme.md
+++ b/keyboards/singa/readme.md
@@ -1,52 +1,22 @@
1# Singa 1# Singa
2 2
3
4![Singa](https://i.imgur.com/VVO27Tr.jpg) 3![Singa](https://i.imgur.com/VVO27Tr.jpg)
5 4
6
775% Custom Keyboard. 575% Custom Keyboard.
8 6
9 7* Keyboard Maintainer: [amnesia0287](https://github.com/amnesia0287)
10Keyboard Maintainer: [amnesia0287](https://github.com/amnesia0287) 8* Hardware Supported: TGR-Elaine v1.0 PCB
11Hardware Supported: TGR-Elaine v1.0 PCB 9* Hardware Availability: http://singakbd.com/
12Hardware Availability: http://singakbd.com/
13 10
14 11
15Make example for this keyboard (after setting up your build environment): 12Make example for this keyboard (after setting up your build environment):
16 13
17 make singa:default 14 make singa:default
18 15
19Flashing 16Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
20 17
21ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods. 18 make singa:default:flash
22
23**Reset Key:** Hold down the key located at `K00`, commonly programmed as `Esc` while plugging in the keyboard.
24
25Windows:
261. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
272. Place your keyboard into reset.
283. Press the `Find Device` button and ensure that your keyboard is found.
294. Press the `Open .hex File` button and locate the `.hex` file you created.
305. Press the `Flash Device` button and wait for the process to complete.
31
32macOS:
331. Install homebrew by typing the following:
34 ```
35 /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
36 ```
372. Install `crosspack-avr`.
38 ```
39 brew cask install crosspack-avr
40 ```
413. Install the following packages:
42 ```
43 brew install python3
44 pip3 install pyusb
45 brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
46 ```
47
484. Place your keyboard into reset.
495. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file.
50 19
20**Reset Key:** Hold down the key located at `K00`, commonly programmed as `Esc` while plugging in the keyboard.
51 21
52See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). 22See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
diff --git a/keyboards/tgr/alice/readme.md b/keyboards/tgr/alice/readme.md
index f5db63814..a08aaf71b 100644
--- a/keyboards/tgr/alice/readme.md
+++ b/keyboards/tgr/alice/readme.md
@@ -4,45 +4,18 @@
4 4
5An ergonomic 60% keyboard. 5An ergonomic 60% keyboard.
6 6
7Keyboard Maintainer: [Felipe Coury](https://github.com/fcoury) 7* Keyboard Maintainer: [Felipe Coury](https://github.com/fcoury)
8Hardware Supported: TGR Alice 8* Hardware Supported: TGR Alice
9Hardware Availability: Group buy finished 9* Hardware Availability: Group buy finished
10 10
11Make example for this keyboard (after setting up your build environment): 11Make example for this keyboard (after setting up your build environment):
12 12
13 make tgr/alice:default 13 make tgr/alice:default
14 14
15Flashing 15Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
16
17ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods.
18
19**Reset Key:** Hold down the key located at `K00`, commonly programmed as `Esc` while plugging in the keyboard.
20
21Windows:
221. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
232. Place your keyboard into reset.
243. Press the `Find Device` button and ensure that your keyboard is found.
254. Press the `Open .hex File` button and locate the `.hex` file you created.
265. Press the `Flash Device` button and wait for the process to complete.
27
28macOS:
291. Install homebrew by typing the following:
30 ```
31 /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
32 ```
332. Install `crosspack-avr`.
34 ```
35 brew cask install crosspack-avr
36 ```
373. Install the following packages:
38 ```
39 brew install python3
40 pip3 install pyusb
41 brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
42 ```
43
444. Place your keyboard into reset.
455. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file.
46 16
17 make tgr/alice:default:flash
18
19**Reset Key**: Hold down the key located at *K00*, commonly programmed as *Esc* while plugging in the keyboard.
47 20
48See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). 21See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
diff --git a/keyboards/tgr/jane/readme.md b/keyboards/tgr/jane/readme.md
index 10986cde3..5c5a2d92d 100644
--- a/keyboards/tgr/jane/readme.md
+++ b/keyboards/tgr/jane/readme.md
@@ -2,46 +2,18 @@
2 2
3TKL Custom Keyboard. 3TKL Custom Keyboard.
4 4
5Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin) 5* Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)
6Hardware Supported: TGR Jane (Pontoporia) PCB v1.1, v1.2 6* Hardware Supported: TGR Jane (Pontoporia) PCB v1.1, v1.2
7Hardware Availability: [Geekhack Group Buy](https://geekhack.org/index.php?topic=97552.1200) 7* Hardware Availability: [Geekhack Group Buy](https://geekhack.org/index.php?topic=97552.1200)
8
9 8
10Make example for this keyboard (after setting up your build environment): 9Make example for this keyboard (after setting up your build environment):
11 10
12 make tgr/jane:default 11 make tgr/jane:default
13 12
14Flashing 13Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
15 14
16ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods. 15 make tgr/jane:default:flash
17
18**Reset Key:** Hold down the key located at `K00`, commonly programmed as `Esc` while plugging in the keyboard.
19
20Windows:
211. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
222. Place your keyboard into reset.
233. Press the `Find Device` button and ensure that your keyboard is found.
244. Press the `Open .hex File` button and locate the `.hex` file you created.
255. Press the `Flash Device` button and wait for the process to complete.
26
27macOS:
281. Install homebrew by typing the following:
29 ```
30 /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
31 ```
322. Install `crosspack-avr`.
33 ```
34 brew cask install crosspack-avr
35 ```
363. Install the following packages:
37 ```
38 brew install python3
39 pip3 install pyusb
40 brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
41 ```
42
434. Place your keyboard into reset.
445. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file.
45 16
17**Reset Key**: Hold down the key located at *K00*, commonly programmed as *Esc* while plugging in the keyboard.
46 18
47See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). 19See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
diff --git a/keyboards/unikorn/readme.md b/keyboards/unikorn/readme.md
index 1f8b16d64..1383e1851 100644
--- a/keyboards/unikorn/readme.md
+++ b/keyboards/unikorn/readme.md
@@ -2,59 +2,29 @@
2 2
360% PCB made for the TGR x SINGA Unikorn60. 360% PCB made for the TGR x SINGA Unikorn60.
4 4
5 5* Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)
6Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin) 6* Hardware Supported: Unikorn 60 PCB
7Hardware Supported: Unikorn 60 PCB 7* Hardware Availability: [Geekhack GB](https://geekhack.org/index.php?topic=98350.0)
8Hardware Availability: [Geekhack GB](https://geekhack.org/index.php?topic=98350.0)
9
10 8
11Make example for this keyboard (after setting up your build environment): 9Make example for this keyboard (after setting up your build environment):
12 10
13 make unikorn:default 11 make unikorn:default
14 12
15This PCB can support RGB underglow. There are pads on the bottom of the PCB for the LED controller chip and for 17 RGB underglow LEDs. The Unikorn 60 case does not have acrylic pieces to properly display underglow effects. 13Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
16
17To enable RGB lighting support, install the necessary components and set RGBLIGHT features in `rules.mk` like so:
18
19```
20RGBLIGHT_ENABLE = yes
21```
22
23
24Flashing
25 14
26ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods. 15 make unikorn:default:flash
27 16
28**Reset Key:** Short the two holes labeled `FW_JP` underneath the PCB, beside the Tab key while plugging in the keyboard. 17**Reset Key**: Short the two holes labeled `FW_JP` underneath the PCB, beside the Tab key while plugging in the keyboard.
29 18
30Do not confuse this with the LED holes of the switch in the `Tab` position. `FW_JP` is not reachable from the top as the plate blocks access to it. 19Do not confuse this with the LED holes of the switch in the `Tab` position. `FW_JP` is not reachable from the top as the plate blocks access to it.
31 20
32It is recommended to program a `RESET` key in your keymap. 21See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
33
34Windows:
351. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
362. Place your keyboard into reset.
373. Press the `Find Device` button and ensure that your keyboard is found.
384. Press the `Open .hex File` button and locate the `.hex` file you created.
395. Press the `Flash Device` button and wait for the process to complete.
40
41macOS:
421. Install homebrew by typing the following:
43 ```
44 /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
45 ```
462. Install `crosspack-avr`.
47 ```
48 brew cask install crosspack-avr
49 ```
503. Install the following packages:
51 ```
52 brew install python3
53 pip3 install pyusb
54 brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
55
564. Place your keyboard into reset.
575. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file.
58 22
23## RGB Underglow
24This PCB can support RGB underglow. There are pads on the bottom of the PCB for the LED controller chip and for 17 RGB underglow LEDs. The Unikorn 60 case does not have acrylic pieces to properly display underglow effects.
59 25
60See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). 26To enable RGB lighting support, install the necessary components and set RGBLIGHT features in `rules.mk` like so:
27
28```makefile
29RGBLIGHT_ENABLE = yes
30```
diff --git a/keyboards/winkeyless/bface/README.md b/keyboards/winkeyless/bface/README.md
index da0eb8088..ab39a97db 100644
--- a/keyboards/winkeyless/bface/README.md
+++ b/keyboards/winkeyless/bface/README.md
@@ -2,45 +2,18 @@
2 2
3A 60% keyboard with RGB that runs ps2avrgb natively. Please note that the B.face and B.fake have different switch matrices. Firmware on one, will not work on the other. 3A 60% keyboard with RGB that runs ps2avrgb natively. Please note that the B.face and B.fake have different switch matrices. Firmware on one, will not work on the other.
4 4
5Keyboard Maintainer: QMK Community 5* Keyboard Maintainer: QMK Community
6Hardware Supported: B.face PCB 6* Hardware Supported: B.face PCB
7Hardware Availability: [Winkeyless](https://winkeyless.kr/product/b-face-x2-pcb/) 7* Hardware Availability: [Winkeyless](https://winkeyless.kr/product/b-face-x2-pcb/)
8 8
9Make example for this keyboard (after setting up your build environment): 9Make example for this keyboard (after setting up your build environment):
10 10
11 make winkeyless/bface:default 11 make winkeyless/bface:default
12 12
13Flashing 13Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
14
15ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods.
16
17**Reset Key:** Hold down the key located at K00, commonly programmed as left control while plugging in the keyboard.
18
19Windows:
201. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
212. Place your keyboard into reset.
223. Press the `Find Device` button and ensure that your keyboard is found.
234. Press the `Open .hex File` button and locate the `.hex` file you created.
245. Press the `Flash Device` button and wait for the process to complete.
25
26macOS:
271. Install homebrew by typing the following:
28 ```
29 /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
30 ```
312. Install `crosspack-avr`.
32 ```
33 brew cask install crosspack-avr
34 ```
353. Install the following packages:
36 ```
37 brew install python
38 pip3 install pyusb
39 brew install --HEAD`https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
40 ```
41
424. Place your keyboard into reset.
435. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file.
44 14
15 make winkeyless/bface:default:flash
16
17**Reset Key**: Hold down the key located at *K00*, commonly programmed as *left control* while plugging in the keyboard.
45 18
46See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). 19See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
diff --git a/keyboards/winkeyless/bmini/readme.md b/keyboards/winkeyless/bmini/readme.md
index 3401b9744..b8cc85495 100644
--- a/keyboards/winkeyless/bmini/readme.md
+++ b/keyboards/winkeyless/bmini/readme.md
@@ -2,42 +2,18 @@
2 2
3A 75% keyboard with RGB 3A 75% keyboard with RGB
4 4
5Keyboard Maintainer: QMK Community 5* Keyboard Maintainer: QMK Community
6Hardware Supported: B.mini PCB 6* Hardware Supported: B.mini PCB
7Hardware Availability: http://winkeyless.kr/product/b-mini-x2-pcb/ 7* Hardware Availability: <http://winkeyless.kr/product/b-mini-x2-pcb/>
8 8
9Make example for this keyboard (after setting up your build environment): 9Make example for this keyboard (after setting up your build environment):
10 10
11 make winkeyless/bmini:default 11 make winkeyless/bmini:default
12 12
13Flashing 13Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
14
15ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods.
16
17Windows:
181. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
192. Place your keyboard into reset.
203. Press the `Find Device` button and ensure that your keyboard is found.
214. Press the `Open .hex File` button and locate the `.hex` file you created.
225. Press the `Flash Device` button and wait for the process to complete.
23
24macOS:
251. Install homebrew by typing the following:
26 ```
27 /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
28 ```
292. Install `crosspack-avr`.
30 ```
31 brew cask install crosspack-avr
32 ```
333. Install the following packages:
34 ```
35 brew install python
36 brew install pyusb
37 brew install --HEAD`https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
38
394. Place your keyboard into reset.
405. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file.
41 14
15 make winkeyless/bmini:default:flash
16
17**Reset Key**: Hold down the key located at *LOCATION*, commonly programmed as *KEY* while plugging in the keyboard.
42 18
43See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). 19See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
diff --git a/keyboards/winkeyless/bminiex/readme.md b/keyboards/winkeyless/bminiex/readme.md
index 7dbabedba..31a9e2608 100644
--- a/keyboards/winkeyless/bminiex/readme.md
+++ b/keyboards/winkeyless/bminiex/readme.md
@@ -2,12 +2,16 @@
2 2
3A compact fullsize keyboard with RGB 3A compact fullsize keyboard with RGB
4 4
5Keyboard Maintainer: QMK Community 5* Keyboard Maintainer: QMK Community
6Hardware Supported: B.mini EX PCB 6* Hardware Supported: B.mini EX PCB
7Hardware Availability: https://winkeyless.kr/product/b-mini-ex-x2-pcb/ 7* Hardware Availability: <https://winkeyless.kr/product/b-mini-ex-x2-pcb/>
8 8
9Make example for this keyboard (after setting up your build environment): 9Make example for this keyboard (after setting up your build environment):
10 10
11 make winkeyless/bminiex:default 11 make winkeyless/bminiex:default
12 12
13Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
14
15 make winkeyless/bminiex:default:flash
16
13See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). 17See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
diff --git a/keyboards/ymd75/README.md b/keyboards/ymd75/README.md
index d1c4e95ae..9a618c594 100644
--- a/keyboards/ymd75/README.md
+++ b/keyboards/ymd75/README.md
@@ -1,83 +1,19 @@
1YMD75 / MT84 1# YMD75 / MT84
2==========================
3 2
4This is a port of the QMK firmware for boards that are based on the 375% keyboard from YMDK. YMDK sell the board and name it "YMD75", however the PCB has "MT84" printed on both sides.
5ps2avrGB firmware, like the [ps2avrGB keyboard] (https://www.keyclack.com/product/gb-ps2avrgb/), for use on the YMD75, from YMDK. YMDK sell the board and name it "YMD75", however the PCB has "MT84" printed on both sides.
6 4
7Most of the code was taken and amended from YMD96 and my port JJ50, which in itself was taken from ps2avrGB and amended by Andrew Novak. 5* Keyboard Maintainer: [Wayne K Jones](github.com/WarmCatUK)
8 6* Hardware Supported: YMD75/MT84 with the ATmega32a chip.
9Note that this is a complete replacement for the firmware, so you won't be 7* Hardware Availability: <https://www.aliexpress.com/item/32812690592.html>
10using Bootmapper Client to change any keyboard settings, since not all the
11USB report options are supported.
12
13Hardware Supported: YMD75/MT84 with the ATmega32a chip.
14Hardware Availability: The YMD75/MT84 PCB is available from YMDK on AliExpress and suchlike.
15
16This version by Wayne K Jones (github.com/WarmCatUK)
17
18## Installing and Building
19 8
20Make example for this keyboard (after setting up your build environment): 9Make example for this keyboard (after setting up your build environment):
21 10
22``` 11 make ymd75:default
23$ make ymd75:default:program
24```
25It should detect the keyboard and set it to bootloader mode automatically, prior to flashing firmware.
26I've found that I need to remove the previous build/file before making a new one as it doesn't overwrite it; but this might just be my personal experience.
27
28See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information.
29
30Note that this is a complete replacement for the firmware, so you won't be
31using Bootmapper Client to change any keyboard settings, since not all the
32USB report options are supported.
33In addition you may need the AVR toolchain and `bootloadHID` for flashing:
34
35```
36$ brew cask install crosspack-avr
37$ brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
38```
39
40In order to use the `./util/atmega32a_program.py` script, which can reboot the board into
41the bootloader, you'll need Python 2 with PyUSB installed:
42
43```
44$ pip install pyusb
45```
46
47If you prefer, you can just build it and flash the firmware directly with
48`bootloadHID` if you boot the board while holding down `Left Control` to keep it
49in the bootloader:
50
51```
52$ make ymd75
53$ bootloadHID -r ymd75_default.hex
54```
55I dont use windows personally, but the following is from ymd96 regarding flashing the atmega32a:
56
57Since the YMD75/MT84 uses an ATmega32a chip instead of the 32u4, you need to download [HIDBootFlash v.1.0](http://vusb.wikidot.com/project:hidbootflash) for Windows. If anyone knows of a Linux/Mac bootflasher that works, edit this readme!
58On Windows, I use [MINGw](http://www.mingw.org/) to compile the keymaps. On Linux or OSX you can simply use the terminal.
59
60Once you have those two pieces of software:
61Build the keyboard with
62```
63$ make ymd75:default
64```
65If you make your own layout, change the `default` word to whatever your layout is.
66
67And flash the compiled hex file with `HIDBootFlash`. Simply put the board in flashing mode by plugging it in while holding the key below the top right key, and click `find device`. Then you can specify the .hex file and flash it to the device.
68
69
70## Troubleshooting
71 12
721. Try plugging the board in while pressing `Backspace` (`Key below the top right key`). This will force it to boot only the bootloader without loading the firmware. Once this is done, just reflash the board with the original firmware. 13Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
732. Sometimes USB hubs can act weird, so try connecting the board directly to your computer or plugging/unplugging the USB hub.
743. If you get an error such as "Resource Unavailable" when attemting to flash on Linux, you may want to compile and run `tools/usb_detach.c`. See `tools/README.md` for more info.
754. I was occasionally finding that I wasn't flashing changes that I was making to my keymap. If that happens, remove the previous build and simply force rebuild by making with:
76```
77$ rm ymd75_default.hex
78$ make -B ymd75:default
79$ make -B ymd75:default:program
80```
81 14
15 make ymd75:default:flash
82 16
17**Reset Key**: Hold down the key located at *Key below the top right key*, commonly programmed as *Backspace* while plugging in the keyboard.
83 18
19See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
diff --git a/keyboards/ymd96/readme.md b/keyboards/ymd96/readme.md
index 9cb376058..59d6b7337 100644
--- a/keyboards/ymd96/readme.md
+++ b/keyboards/ymd96/readme.md
@@ -1,63 +1,19 @@
1YMD96 1# YMD96
2==========================
3 2
4This is a port of the QMK firmware for boards that are based on the 3A 96-keyboard which supports both ANSI and ISO along with many different layout combinations, and RGB underglow.
5ps2avrGB firmware, like the [ps2avrGB
6keyboard](https://www.keyclack.com/product/gb-ps2avrgb/), for use on the YMD96.
7 4
8Note that this is a complete replacement for the firmware, so you won't be 5* Keyboard maintainer: [Andrew](https://github.com/sparkyman215)
9using Bootmapper Client to change any keyboard settings, since not all the 6* Hardware Supported: YMD96 with the ATmega32a chip.
10USB report options are supported. 7* Hardware Availability: The GB was run June 2017, [in this thread](https://www.reddit.com/r/mechmarket/comments/6hu3yx/vendor_ymd96_gb_is_now_live_68_an_universal_and/). The vendor has stated that they plan on selling more rounds.
11 8
12Here is the default layout, it is fairly simple with a few function keys: 9Make example for this keyboard (after setting up your build environment):
13![YMD96 Layout](https://i.imgur.com/3QnqVPn.png)
14If you have a different layout (since there were many options during the GB), please feel free to contribute!
15 10
16Keyboard maintainer: [Andrew](https://github.com/sparkyman215) 11 make ymd96:default
17Hardware Supported: YMD96 with the ATmega32a chip.
18Hardware Availability: The GB was run June 2017, [in this thread](https://www.reddit.com/r/mechmarket/comments/6hu3yx/vendor_ymd96_gb_is_now_live_68_an_universal_and/). The vendor has stated that they plan on selling more rounds.
19 12
20A very big thanks to @krusli for making the RGB underglow, Backlight, CapsLock and NumLock LEDs working correctly. 13Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
21 14
22## Finding your specific matrix 15 make ymd96:default:flash
23 16
24This firmware was modified from [ps2avrGB](https://github.com/qmk/qmk_firmware/tree/master/keyboards/ps2avrGB), also found on this qmk repo, to work with the YMD96 keyboard. However, I only have one board to test with, which might have a different layout than yours. To get qmk working with your specific layout, you'll need to follow these steps: 17**Reset Key**: Hold down the key commonly programmed as *L_Ctrl* while plugging in the keyboard.
25 18
261. Follow the [guide here](https://www.massdrop.com/talk/1392/programming-kbd-keyboards-via-bootmapper-client) to get Bootmapper Client setup. While you won't need it after you get qmk working, you need to use Bootmapper Client to figure out how the matrix is laid out. In the end, here's an example of what it should look like: ![BMC](https://i.imgur.com/wNihDwn.png) 19See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
272. Next is the tricky part: editing the `ymd96.h` file. Here, you have to figure out how the keys are laid out physically and assign each key the right keycode. Study how the codes in brackets correspond to the BMC columns. Consider the first column: K000 corresponds to Col 1 Row 1, and K100 corresponds to Col 2 Row 1. K111 = Col 2 Row 10.
283. First, you need to define the codes that are actually used in the brackets. KC_NO is used whenever a cell isn't used, such as col 1 row 4-6 in BMC.
294. Once you have all those set up, you need to put the keycodes where they physically are in the KEYMAP( area. Since the columns aren't all uniform (e.g. col2row6 is B, but col2row7 is the numpad 1), the keycodes will be all over the place.
305. Finally! Hard part is pretty much done. Next, you simply have to edit the `keymap.c` file to actually assign the keycodes to do something. You essentially replace the keycodes (e.g. K000) with actual codes that do something, e.g. KC_ENTER. Modify these to your hearts content, and of course this is where all the extra functionality of QMK shines. I won't get into it here, but hopefully you've made it this far!
31
32## Installing and Building
33
34Since the YMD96 uses an ATmega32a chip instead of the 32u4, you need to download [HIDBootFlash v.1.0](http://vusb.wikidot.com/project:hidbootflash) for Windows. For Linux you can use the [bootloadHID](https://www.obdev.at/products/vusb/bootloadhid.html) utility (which will require building). Arch Linux users can alternatively install this from the [AUR](https://aur.archlinux.org/packages/bootloadhid/).
35On Windows, I use [MINGw](http://www.mingw.org/) to compile the keymaps. On Linux, you can simply use the terminal.
36
37Once you have those two pieces of software:
38Build the keyboard by navigating to the root folder of the QMK repo and running
39```
40$ make ymd96:default
41```
42If you make your own layout, change the `default` word to whatever your layout is.
43
44To flash the compiled hex file, simply put the board in flashing mode by plugging it in while holding control.
45In `HIDBootFlash` first click `find device`, then you can specify the .hex file and flash it to the device.
46For `bootloadHID`, from a terminal that is in the same folder as your firmware file, run
47```
48$ sudo bootloadHID ymd96_default.hex
49```
50Again replacing default with your custom keymap name if required.
51
52## Troubleshooting
53
54From my experience, it's really hard to brick these boards. But these
55tricks have been useful when it got stuck in a weird scenario.
56
571. Try plugging the board in while pressing `L_Ctrl`. This will force it
58 to boot only the bootloader without loading the firmware. Once this is
59 done, just reflash the board with the original firmware.
602. Sometimes USB hubs can act weird, so try connecting the board directly
61 to your computer or plugging/unplugging the USB hub.
62
63Lastly, if you still need help, you can add me on Discord and I'll be happy to help.
diff --git a/keyboards/ymdk/bface/README.md b/keyboards/ymdk/bface/README.md
index f6a703bec..04ba680de 100644
--- a/keyboards/ymdk/bface/README.md
+++ b/keyboards/ymdk/bface/README.md
@@ -1,55 +1,21 @@
1# The YMDK "Bface" PCB 1# The YMDK Bface
2 2
3![ymdk_bface](https://i.imgur.com/qhFxN0g.jpg) 3![ymdk_bface](https://i.imgur.com/qhFxN0g.jpg)
4 4
5A 60% keyboard that runs ps2avrgb natively and fits the popular GH60 form factor. Another "bfake" or clone of the original B.face PCB by [Winkeyless](https://winkeyless.kr/product/b-face-x2-pcb/). This PCB has slightly different switch matrix than the origninal B.face, and is also different than the bfake. It commonly comes as the PCB in 60% keyboard kits sold by YMDK on Aliexpress. 5A 60% keyboard that runs ps2avrgb natively and fits the popular GH60 form factor. Another "bfake" or clone of the original B.face PCB by [Winkeyless](https://winkeyless.kr/product/b-face-x2-pcb/). This PCB has slightly different switch matrix than the origninal B.face, and is also different than the bfake. It commonly comes as the PCB in 60% keyboard kits sold by YMDK on Aliexpress.
6 6
7Keyboard Maintainer: QMK Community 7* Keyboard Maintainer: QMK Community
8Hardware Supported: White Bface Mini USB PCB with no RGB. 8* Hardware Supported: White Bface Mini USB PCB with no RGB.
9Hardware Availability: [Shenzhen YMD Tech Co. (YMDK) on Aliexpress](https://www.aliexpress.com/item/32799437588.html) 9* Hardware Availability: [Shenzhen YMD Tech Co. (YMDK) on Aliexpress](https://www.aliexpress.com/item/32799437588.html)
10 10
11Make example for this keyboard (after setting up your build environment): 11Make example for this keyboard (after setting up your build environment):
12 12
13 make ymdk/bface:default 13 make ymdk/bface:default
14 14
15Flashing: 15Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
16 16
17ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods. 17 make ymdk/bface:default:flash
18 18
19This board has a pair of jumper holes on the left edge of the PCB marked "Jb", near TAB and CAPS LOCK. If you short the contacts with tweezers or wire the board will enter into the bootloader and you can flash it. 19This board has a pair of jumper holes on the left edge of the PCB marked "Jb", near TAB and CAPS LOCK. If you short the contacts with tweezers or wire the board will enter into the bootloader and you can flash it.
20 20
21Windows:
221. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
232. Place your keyboard into reset.
243. Press the `Find Device` button and ensure that your keyboard is found.
254. Press the `Open .hex File` button and locate the `.hex` file you created.
265. Press the `Flash Device` button and wait for the process to complete.
27
28macOS:
291. Install homebrew by typing the following:
30 ```
31 /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
32 ```
332. Install `crosspack-avr`.
34 ```
35 brew cask install crosspack-avr
36 ```
373. Install the following packages:
38 ```
39 brew install python
40 pip3 install pyusb
41 brew install --HEAD`https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
42 ```
43
444. Place your keyboard into reset by shorting the jumper on the left edge of the PCB..
455. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file.
46
47Another method for Mac or Linux:
48After installing `bootloadHID`, you can use the `./util/atmega32a_program.py` program included in QMK. You will need to have `python` and the `pyusb` library installed.
49
50Then you can run this to compile the firmware and flash the board without using the jumper:
51```
52make ymdk/bface:default:program
53```
54
55See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). 21See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
diff --git a/keyboards/ymdk_np21/README.md b/keyboards/ymdk_np21/README.md
index 79e3386f0..decd30b27 100644
--- a/keyboards/ymdk_np21/README.md
+++ b/keyboards/ymdk_np21/README.md
@@ -4,14 +4,18 @@
4 4
5ps2avrGB based number-pad sold fully assembled by YMDK on Aliexpress. 5ps2avrGB based number-pad sold fully assembled by YMDK on Aliexpress.
6 6
7Keyboard Maintainer: [QMK Community](https://github.com/qmk) 7* Keyboard Maintainer: [QMK Community](https://github.com/qmk)
8Hardware Supported: Atmega32A 8* Hardware Supported: Atmega32A
9Hardware Availability: [AliExpress](https://www.aliexpress.com/item/21-Key-NPKC-Programmable-Cherry-MX-Kailh-Gateron-Switches-Mechanical-Keyboard-Numpad-Free-shipping/32812732361.html) 9* Hardware Availability: [AliExpress](https://www.aliexpress.com/item/21-Key-NPKC-Programmable-Cherry-MX-Kailh-Gateron-Switches-Mechanical-Keyboard-Numpad-Free-shipping/32812732361.html)
10 10
11Make example for this keyboard (after setting up your build environment): 11Make example for this keyboard (after setting up your build environment):
12 12
13 make ymdk_np21:default:program 13 make ymdk_np21:default
14 14
15Plugging the board in while pressing 'Top Left Key' (USB on top) will force it to boot bootloader without loading the firmware. 15Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
16 16
17The code for NP21 is a minor edit of jj40. 17 make ymdk_np21:default:flash
18
19**Reset Key**: Hold down the 'Top Left Key' (USB on top) while plugging in the keyboard.
20
21See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
generated by cgit v1.2.3 (git 2.25.1) at 2025-07-04 01:41:05 +0000