diff options
Diffstat (limited to 'keyboards')
36 files changed, 275 insertions, 1245 deletions
diff --git a/keyboards/ares/readme.md b/keyboards/ares/readme.md index 338113a13a..376cee437f 100644 --- a/keyboards/ares/readme.md +++ b/keyboards/ares/readme.md @@ -1,42 +1,17 @@ -lSJ Ares -======== +# lSJ Ares -Keyboard Maintainer: QMK Community -Hardware Supported: LSJ Ares PCB -Hardware Availability: https://geekhack.org/index.php?topic=93146.0 +* Keyboard Maintainer: QMK Community +* Hardware Supported: LSJ Ares PCB +* Hardware Availability: <https://geekhack.org/index.php?topic=93146.0> Make example for this keyboard (after setting up your build environment): make ares:default -Flashing +Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid)) -ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods. + make ares:default:flash -Windows: -1. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash). -2. Place your keyboard into reset by holding the left control key and plugging the cable in. -3. Press the `Find Device` button and ensure that your keyboard is found. -4. Press the `Open .hex File` button and locate the `.hex` file you created. -5. Press the `Flash Device` button and wait for the process to complete. +**Reset Key**: Hold down the *left control* key while plugging in the keyboard. -macOS: -1. Install homebrew by typing the following: - ``` - /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" - ``` -2. Install `crosspack-avr`. - ``` - brew cask install crosspack-avr - ``` -3. Install the following packages: - ``` - brew install python - brew install pyusb - brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb - -4. Place your keyboard into reset. -5. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file. - - -See [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. +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). diff --git a/keyboards/bfake/readme.md b/keyboards/bfake/readme.md index 1ccc25f2dc..df319cd7c5 100644 --- a/keyboards/bfake/readme.md +++ b/keyboards/bfake/readme.md @@ -1,44 +1,17 @@ -B.fake -======== +# B.fake -A 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/). +A 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/). -Keyboard Maintainer: QMK Community -Hardware Supported: B.fake PCB -Hardware Availability: https://www.aliexpress.com/store/product/bface-60-RGB-underground-copy-pcb-from-china-gh60-pcb-Customize-keyboard-PCB/2230037_32731084597.html +* Keyboard Maintainer: QMK Community +* Hardware Supported: B.fake PCB +* Hardware Availability: <https://www.aliexpress.com/store/product/bface-60-RGB-underground-copy-pcb-from-china-gh60-pcb-Customize-keyboard-PCB/2230037_32731084597.html> Make example for this keyboard (after setting up your build environment): make bfake:default -Flashing +Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid)) -ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods. + make bfake:default:flash -Windows: -1. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash). -2. Place your keyboard into reset. -3. Press the `Find Device` button and ensure that your keyboard is found. -4. Press the `Open .hex File` button and locate the `.hex` file you created. -5. Press the `Flash Device` button and wait for the process to complete. - -macOS: -1. Install homebrew by typing the following: - ``` - /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" - ``` -2. Install `crosspack-avr`. - ``` - brew cask install crosspack-avr - ``` -3. Install the following packages: - ``` - brew install python - brew install pyusb - brew install --HEAD`https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb - -4. Place your keyboard into reset. -5. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file. - - -See [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. +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). diff --git a/keyboards/coseyfannitutti/discipline/readme.md b/keyboards/coseyfannitutti/discipline/readme.md index d11f1724f6..d850151d15 100644 --- a/keyboards/coseyfannitutti/discipline/readme.md +++ b/keyboards/coseyfannitutti/discipline/readme.md @@ -4,12 +4,16 @@ A 65% keyboard that can be assembled with only through hole components, including usb type-c -Keyboard Maintainer: [coseyfannitutti](https://github.com/coseyfannitutti) -Hardware Supported: DISCIPLINE, atmega32a -Hardware Availability: [cftkb.com](http://www.cftkb.com), [GitHub](https://github.com/coseyfannitutti/discipline) +* Keyboard Maintainer: [coseyfannitutti](https://github.com/coseyfannitutti) +* Hardware Supported: DISCIPLINE, atmega32a +* Hardware Availability: [cftkb.com](http://www.cftkb.com), [GitHub](https://github.com/coseyfannitutti/discipline) Make example for this keyboard (after setting up your build environment): make coseyfannitutti/discipline:default +Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid)) + + make coseyfannitutti/discipline:default:flash + 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). diff --git a/keyboards/donutcables/budget96/readme.md b/keyboards/donutcables/budget96/readme.md index c83040360a..11c49b9834 100644 --- a/keyboards/donutcables/budget96/readme.md +++ b/keyboards/donutcables/budget96/readme.md @@ -2,44 +2,18 @@ 96 key atmega32a keyboard. -Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin) -Hardware Supported: Budget96 PCB -Hardware Availability: [DonutCables](https://donutcables.com/) +* Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin) +* Hardware Supported: Budget96 PCB +* Hardware Availability: [DonutCables](https://donutcables.com/) Make example for this keyboard (after setting up your build environment): make donutcables/budget96:default -Flashing - -**Reset Key:** Hold down the key located at `K00`, commonly programmed as left control while plugging in the keyboard. - -ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods. - -Windows: -1. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash). -2. Place your keyboard into reset. -3. Press the `Find Device` button and ensure that your keyboard is found. -4. Press the `Open .hex File` button and locate the `.hex` file you created. -5. Press the `Flash Device` button and wait for the process to complete. - -macOS: -1. Install homebrew by typing the following: - ``` - /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" - ``` -2. Install `crosspack-avr`. - ``` - brew cask install crosspack-avr - ``` -3. Install the following packages: - ``` - brew install python3 - pip3 install pyusb - brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb - ``` - -4. Place your keyboard into reset. -5. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file. +Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid)) + + make donutcables/budget96:default:flash + +**Reset Key**: Hold down the key located at *K00*, commonly programmed as *left control* while plugging in the keyboard. 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). diff --git a/keyboards/eve/meteor/readme.md b/keyboards/eve/meteor/readme.md index 8e933c09d1..28884156ea 100644 --- a/keyboards/eve/meteor/readme.md +++ b/keyboards/eve/meteor/readme.md @@ -2,50 +2,20 @@ 60% PCB with Function Row - -Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin) -Hardware Supported: EVE Meteor -Hardware Availability: [zFrontier](https://en.zfrontier.com/products/eve-meteor) - +* Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin) +* Hardware Supported: EVE Meteor +* Hardware Availability: [zFrontier](https://en.zfrontier.com/products/eve-meteor) Make example for this keyboard (after setting up your build environment): make eve/meteor:default -Flashing +Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid)) -ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods. + make eve/meteor:default:flash **Reset Key:** Short the two holes labeled `FW_JP` underneath the PCB, beside the Tab key while plugging in the keyboard. Do 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. -It is recommended to program a `RESET` key in your keymap. - -Windows: -1. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash). -2. Place your keyboard into reset. -3. Press the `Find Device` button and ensure that your keyboard is found. -4. Press the `Open .hex File` button and locate the `.hex` file you created. -5. Press the `Flash Device` button and wait for the process to complete. - -macOS: -1. Install homebrew by typing the following: - ``` - /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" - ``` -2. Install `crosspack-avr`. - ``` - brew cask install crosspack-avr - ``` -3. Install the following packages: - ``` - brew install python3 - pip3 install pyusb - brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb - ``` -4. Place your keyboard into reset. -5. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file. - - 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). diff --git a/keyboards/exclusive/e6v2/le_bmc/readme.md b/keyboards/exclusive/e6v2/le_bmc/readme.md index 4dc8e6ef51..561560a3e3 100644 --- a/keyboards/exclusive/e6v2/le_bmc/readme.md +++ b/keyboards/exclusive/e6v2/le_bmc/readme.md @@ -2,43 +2,18 @@ These 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. -Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin) -Hardware Supported: ps2avrgb E6-V2 with atmega32a microcontroller -Hardware Availability: [geekhack.org/index.php?topic=90787.0](https://geekhack.org/index.php?topic=90787.0) +* Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin) +* Hardware Supported: ps2avrgb E6-V2 with atmega32a microcontroller +* Hardware Availability: [geekhack.org/index.php?topic=90787.0](https://geekhack.org/index.php?topic=90787.0) Make example for this keyboard (after setting up your build environment): make exclusive/e6v2/le_bmc:default -Flashing - -ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods. - -**Reset Key:** Hold down the key located at `K00`, commonly programmed as left control while plugging in the keyboard. - -Windows: -1. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash). -2. Place your keyboard into reset. -3. Press the `Find Device` button and ensure that your keyboard is found. -4. Press the `Open .hex File` button and locate the `.hex` file you created. -5. Press the `Flash Device` button and wait for the process to complete. - -macOS: -1. Install homebrew by typing the following: - ``` - /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" - ``` -2. Install `crosspack-avr`. - ``` - brew cask install crosspack-avr - ``` -3. Install the following packages: - ``` - brew install python3 - pip3 install pyusb - brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb - ``` -4. Place your keyboard into reset. -5. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file. +Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid)) + + make exclusive/e6v2/le_bmc:default:flash + +**Reset Key**: Hold down the key located at *K00*, commonly programmed as *left control* while plugging in the keyboard. 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). diff --git a/keyboards/exclusive/e6v2/oe_bmc/readme.md b/keyboards/exclusive/e6v2/oe_bmc/readme.md index a386abf6c0..cd6da0ff0b 100644 --- a/keyboards/exclusive/e6v2/oe_bmc/readme.md +++ b/keyboards/exclusive/e6v2/oe_bmc/readme.md @@ -2,43 +2,18 @@ These 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. -Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin) -Hardware Supported: ps2avrgb E6-V2 with atmega32a microcontroller -Hardware Availability: [geekhack.org/index.php?topic=90787.0](https://geekhack.org/index.php?topic=90787.0) +* Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin) +* Hardware Supported: ps2avrgb E6-V2 with atmega32a microcontroller +* Hardware Availability: [geekhack.org/index.php?topic=90787.0](https://geekhack.org/index.php?topic=90787.0) Make example for this keyboard (after setting up your build environment): make exclusive/e6v2/oe_bmc:default -Flashing - -ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods. - -**Reset Key:** Hold down the key located at `K00`, commonly programmed as left control while plugging in the keyboard. - -Windows: -1. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash). -2. Place your keyboard into reset. -3. Press the `Find Device` button and ensure that your keyboard is found. -4. Press the `Open .hex File` button and locate the `.hex` file you created. -5. Press the `Flash Device` button and wait for the process to complete. - -macOS: -1. Install homebrew by typing the following: - ``` - /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" - ``` -2. Install `crosspack-avr`. - ``` - brew cask install crosspack-avr - ``` -3. Install the following packages: - ``` - brew install python3 - pip3 install pyusb - brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb - -4. Place your keyboard into reset. -5. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file. +Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid)) + + make exclusive/e6v2/oe_bmc:default:flash + +**Reset Key**: Hold down the key located at *K00*, commonly programmed as *left control* while plugging in the keyboard. 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). diff --git a/keyboards/exent/readme.md b/keyboards/exent/readme.md index 08807eda55..a98eff5f03 100644 --- a/keyboards/exent/readme.md +++ b/keyboards/exent/readme.md @@ -2,9 +2,9 @@ 65% custom keyboard with large bezels. -Keyboard Maintainer: [mechmerlin](https://github.com/mechmerlin) -Hardware Supported: Exent PCB -Hardware Availability: [Geekhack GB](https://geekhack.org/index.php?topic=87213.0) +* Keyboard Maintainer: [mechmerlin](https://github.com/mechmerlin) +* Hardware Supported: Exent PCB +* Hardware Availability: [Geekhack GB](https://geekhack.org/index.php?topic=87213.0) Make example for this keyboard (after setting up your build environment): @@ -14,6 +14,6 @@ Flashing example for this keyboard ([after setting up the bootloadHID flashing e make exent:default:flash -**Reset Key**: Hold down the key located at `k0d`, commonly programmed as Backspace while plugging in the keyboard. +**Reset Key**: Hold down the key located at `k0d`, commonly programmed as *Backspace* while plugging in the keyboard. 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). diff --git a/keyboards/facew/readme.md b/keyboards/facew/readme.md index b749d18d29..a852a4f46d 100644 --- a/keyboards/facew/readme.md +++ b/keyboards/facew/readme.md @@ -4,44 +4,18 @@ A 60% no frills keyboard. The 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. -Keyboard Maintainer: [MechMerlin](www.github.com/mechmerlin) -Hardware Supported: FaceW Sprit Edition PCB -Hardware Availability: https://mechanicalkeyboards.com/shop/index.php?l=product_detail&p=1352 +* Keyboard Maintainer: [MechMerlin](www.github.com/mechmerlin) +* Hardware Supported: FaceW Sprit Edition PCB +* Hardware Availability: <https://mechanicalkeyboards.com/shop/index.php?l=product_detail&p=1352> Make example for this keyboard (after setting up your build environment): make facew:default -Flashing - -ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods. - -**Reset Key:** To put the FaceW into reset, hold `q` (`K01`) while plugging in. - -Windows: -1. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash). -2. Place your keyboard into reset. -3. Press the `Find Device` button and ensure that your keyboard is found. -4. Press the `Open .hex File` button and locate the `.hex` file you created. -5. Press the `Flash Device` button and wait for the process to complete. - -macOS: -1. Install homebrew by typing the following: - ``` - /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" - ``` -2. Install `crosspack-avr`. - ``` - brew cask install crosspack-avr - ``` -3. Install the following packages: - ``` - brew install python3 - pip3 install pyusb - brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb - -4. Place your keyboard into reset. -5. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file. +Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid)) + make facew:default:flash + +**Reset Key**: Hold down the key located at *K01*, commonly programmed as *q* while plugging in the keyboard. 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). diff --git a/keyboards/ft/mars80/readme.md b/keyboards/ft/mars80/readme.md index 9622751334..3d108300bb 100644 --- a/keyboards/ft/mars80/readme.md +++ b/keyboards/ft/mars80/readme.md @@ -2,43 +2,18 @@ TKL Keyboard with in switch backlight and RGB Underglow. -Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin) -Hardware Supported: Mars 8.0 PCB -Hardware Availability: [Geekhack Group Buy](https://geekhack.org/index.php?topic=93723.0) +* Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin) +* Hardware Supported: Mars 8.0 PCB +* Hardware Availability: [Geekhack Group Buy](https://geekhack.org/index.php?topic=93723.0) Make example for this keyboard (after setting up your build environment): make ft/mars80:default -Flashing +Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid)) -ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods. + make ft/mars80:default:flash **Reset Key:** Hold down the key located at `K00`, commonly programmed as `Pause/Break` while plugging in the keyboard. -Windows: -1. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash). -2. Place your keyboard into reset. -3. Press the `Find Device` button and ensure that your keyboard is found. -4. Press the `Open .hex File` button and locate the `.hex` file you created. -5. Press the `Flash Device` button and wait for the process to complete. - -macOS: -1. Install homebrew by typing the following: - ``` - /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" - ``` -2. Install `crosspack-avr`. - ``` - brew cask install crosspack-avr - ``` -3. Install the following packages: - ``` - brew install python3 - pip3 install pyusb - brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb - ``` -4. Place your keyboard into reset. -5. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file. - 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). diff --git a/keyboards/gray_studio/hb85/readme.md b/keyboards/gray_studio/hb85/readme.md index c0c2fdf371..7e39f327c1 100644 --- a/keyboards/gray_studio/hb85/readme.md +++ b/keyboards/gray_studio/hb85/readme.md @@ -4,45 +4,18 @@ A Sony HitBit MSX Computer inspired Keyboard. -Keyboard Maintainer: [Felipe Coury](https://github.com/fcoury) -Hardware Supported: Gray Studio HB85 -Hardware Availability: [Group buy](https://en.zfrontier.com/products/gray-hb85) finished +* Keyboard Maintainer: [Felipe Coury](https://github.com/fcoury) +* Hardware Supported: Gray Studio HB85 +* Hardware Availability: [Group buy](https://en.zfrontier.com/products/gray-hb85) finished Make example for this keyboard (after setting up your build environment): make gray_studio/hb85:default -Flashing +Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid)) -ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods. + make gray_studio/hb85:default:flash **Reset Key:** Hold down the key located at `K00`, commonly programmed as F3 while plugging in the keyboard. -Windows: -1. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash). -2. Place your keyboard into reset. -3. Press the `Find Device` button and ensure that your keyboard is found. -4. Press the `Open .hex File` button and locate the `.hex` file you created. -5. Press the `Flash Device` button and wait for the process to complete. - -macOS: -1. Install homebrew by typing the following: - ``` - /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" - ``` -2. Install `crosspack-avr`. - ``` - brew cask install crosspack-avr - ``` -3. Install the following packages: - ``` - brew install python3 - pip3 install pyusb - brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb - -4. Place your keyboard into reset. -5. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file. - -**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. - 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). diff --git a/keyboards/jc65/v32a/readme.md b/keyboards/jc65/v32a/readme.md index 5027f83613..8a139ca664 100644 --- a/keyboards/jc65/v32a/readme.md +++ b/keyboards/jc65/v32a/readme.md @@ -1,32 +1,25 @@ -JC65 ps2avrGB -======= +# JC65  A 65% keyboard with RGB -Keyboard Maintainer: [Jason Barnachea](https://github.com/nautxx) - -Hardware Supported: JC65 rev.ps2avrgb - -Hardware Availability: [keyclack.com](https://keyclack.com/) - The 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. -Please 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. - These docs are for the PS2AVRGB version of the PCB. More info on qmk.fm +* Keyboard Maintainer: [Jason Barnachea](https://github.com/nautxx) +* Hardware Supported: JC65 rev.ps2avrgb +* Hardware Availability: [keyclack.com](https://keyclack.com/) + Make example for this keyboard (after setting up your build environment): make jc65/v32a:default - -Flash example for this keyboard: - bootloadHID -r jc65_v32a_default.hex +Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid)) -Flashing on Windows can be accomplished by downloading [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash) + make jc65/v32a:default:flash -To put the PS2AVRGB board into reset, hold down the left control key while plugging in the keyboard. +**Reset Key**: Hold down the key commonly programmed as *left control* while plugging in the keyboard. -See [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 +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). diff --git a/keyboards/jj40/README.md b/keyboards/jj40/README.md index 7d3612554b..5f4d2c8a99 100644 --- a/keyboards/jj40/README.md +++ b/keyboards/jj40/README.md @@ -4,81 +4,18 @@ A compact 40% (12x4) ortholinear keyboard kit made and KPRepublic on AliExpress. -Keyboard Maintainer: [QMK Community](https://github.com/qmk) -Hardware Supported: Atmega32A -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) +* Keyboard Maintainer: [QMK Community](https://github.com/qmk) +* Hardware Supported: Atmega32A +* Hardware Availability: [AliExpress](https://www.aliexpress.com/store/product/jj40-Custom-Mechanical-Keyboard-40-PCB-programmed-40-planck-layouts-bface-firmware-gh40/3034003_3282878 |