diff options
| author | Joel Challis <git@zvecr.com> | 2019-11-24 04:42:20 +0000 |
|---|---|---|
| committer | James Young <18669334+noroadsleft@users.noreply.github.com> | 2019-11-23 20:42:20 -0800 |
| commit | 6a8c0a6468f4e4ce48a59152418a226d0f027497 (patch) | |
| tree | 4937e648fb7d9afdf89fc6c4c92444ac90153fee /keyboards/facew | |
| parent | d14573620d3e964730af960aab3c05a5d061796f (diff) | |
| download | qmk_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/facew')
| -rw-r--r-- | keyboards/facew/readme.md | 40 |
1 files changed, 7 insertions, 33 deletions
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 | ||
| 5 | 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. | 5 | 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. |
| 6 | 6 | ||
| 7 | Keyboard Maintainer: [MechMerlin](www.github.com/mechmerlin) | 7 | * Keyboard Maintainer: [MechMerlin](www.github.com/mechmerlin) |
| 8 | Hardware Supported: FaceW Sprit Edition PCB | 8 | * Hardware Supported: FaceW Sprit Edition PCB |
| 9 | Hardware 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 | ||
| 11 | Make example for this keyboard (after setting up your build environment): | 11 | Make example for this keyboard (after setting up your build environment): |
| 12 | 12 | ||
| 13 | make facew:default | 13 | make facew:default |
| 14 | 14 | ||
| 15 | Flashing | 15 | Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid)) |
| 16 | |||
| 17 | ps2avr(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 | |||
| 21 | Windows: | ||
| 22 | 1. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash). | ||
| 23 | 2. Place your keyboard into reset. | ||
| 24 | 3. Press the `Find Device` button and ensure that your keyboard is found. | ||
| 25 | 4. Press the `Open .hex File` button and locate the `.hex` file you created. | ||
| 26 | 5. Press the `Flash Device` button and wait for the process to complete. | ||
| 27 | |||
| 28 | macOS: | ||
| 29 | 1. Install homebrew by typing the following: | ||
| 30 | ``` | ||
| 31 | /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" | ||
| 32 | ``` | ||
| 33 | 2. Install `crosspack-avr`. | ||
| 34 | ``` | ||
| 35 | brew cask install crosspack-avr | ||
| 36 | ``` | ||
| 37 | 3. 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 | 4. Place your keyboard into reset. | ||
| 44 | 5. 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 | ||
| 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). | 21 | 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). |