diff options
Diffstat (limited to 'keyboards/kbdfans/kbdpad/mk1/readme.md')
| -rw-r--r-- | keyboards/kbdfans/kbdpad/mk1/readme.md | 40 |
1 files changed, 6 insertions, 34 deletions
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 | ||
| 3 | Custom numpad. | 3 | Custom numpad. |
| 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) | ||
| 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 | ||
| 10 | Make example for this keyboard (after setting up your build environment): | 9 | Make 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 | ||
| 14 | Flashing | 13 | Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid)) |
| 15 | 14 | ||
| 16 | ps2avr(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 | ||
| 20 | Windows: | ||
| 21 | 1. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash). | ||
| 22 | 2. Place your keyboard into reset. | ||
| 23 | 3. Press the `Find Device` button and ensure that your keyboard is found. | ||
| 24 | 4. Press the `Open .hex File` button and locate the `.hex` file you created. | ||
| 25 | 5. Press the `Flash Device` button and wait for the process to complete. | ||
| 26 | |||
| 27 | macOS: | ||
| 28 | 1. Install homebrew by typing the following: | ||
| 29 | ``` | ||
| 30 | /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" | ||
| 31 | ``` | ||
| 32 | 2. Install `crosspack-avr`. | ||
| 33 | ``` | ||
| 34 | brew cask install crosspack-avr | ||
| 35 | ``` | ||
| 36 | 3. 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 | |||
| 43 | 4. Place your keyboard into reset. | ||
| 44 | 5. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file. | ||
| 45 | |||
| 46 | |||
| 47 | 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). | 19 | 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). |