aboutsummaryrefslogtreecommitdiff
path: root/keyboards/pearl
diff options
context:
space:
mode:
authorJoel Challis <git@zvecr.com>2019-11-24 04:42:20 +0000
committerJames Young <18669334+noroadsleft@users.noreply.github.com>2019-11-23 20:42:20 -0800
commit6a8c0a6468f4e4ce48a59152418a226d0f027497 (patch)
tree4937e648fb7d9afdf89fc6c4c92444ac90153fee /keyboards/pearl
parentd14573620d3e964730af960aab3c05a5d061796f (diff)
downloadqmk_firmware-6a8c0a6468f4e4ce48a59152418a226d0f027497.tar.gz
qmk_firmware-6a8c0a6468f4e4ce48a59152418a226d0f027497.zip
[Keyboard] Update ATmega32A readme files to match template (#7462)
* Update atmega32a readme files to match template * Update atmega32a readme files to match template - fixes * Apply suggestions from code review
Diffstat (limited to 'keyboards/pearl')
-rw-r--r--keyboards/pearl/readme.md43
1 files changed, 8 insertions, 35 deletions
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).