diff options
Diffstat (limited to 'keyboards/pearl')
| -rw-r--r-- | keyboards/pearl/readme.md | 43 |
1 files changed, 8 insertions, 35 deletions
diff --git a/keyboards/pearl/readme.md b/keyboards/pearl/readme.md index c39d86cf3d..1f78a5540a 100644 --- a/keyboards/pearl/readme.md +++ b/keyboards/pearl/readme.md @@ -3,45 +3,18 @@ Pearl 40% is a keyboard designed by Koobaczech. It uses an Atmel ATMEGA32A MCU. -Keyboard Maintainer: [Ethan Madden](https://github.com/jetpacktuxedo) -Hardware Supported: Pearl -Hardware Availability: [Geekhack Group Buy](https://geekhack.org/index.php?topic=92259.0) +* Keyboard Maintainer: [Ethan Madden](https://github.com/jetpacktuxedo) +* Hardware Supported: Pearl +* Hardware Availability: [Geekhack Group Buy](https://geekhack.org/index.php?topic=92259.0) Make example for this keyboard (after setting up your build environment): make pearl: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`. - -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. +Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid)) + + make pearl:default:flash + +**Reset Key**: Hold down the key located at *K00*, commonly programmed as *Esc* 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). |