summaryrefslogtreecommitdiff
path: root/keyboards/facew/readme.md
diff options
context:
space:
mode:
authorMechMerlin <30334081+mechmerlin@users.noreply.github.com>2019-04-07 07:30:40 -0700
committerDrashna Jaelre <drashna@live.com>2019-04-07 07:30:40 -0700
commit0231caa25aa258a79a7fb73cc57723655055b928 (patch)
tree90624a1942962dcf78a50a5c13bc355c1f43a321 /keyboards/facew/readme.md
parent5c1ef2bddc0fa5d4753d33a5ec8fed5d9da736c8 (diff)
[Keyboard] Refactor FaceW for new BMC changes (#5575)
* use #pragma once for guards * update readme and fix pyusb install instructions * replace custom i2c code with QMK i2c_master * remove unneeded code from config.h * fix keyboard name * remove custom matrix and i2c driver * turn off bootmagic, turn on leds * remove keymap in favor of userspace/community layouts keymap * remove custom matrix * update readme
Diffstat (limited to 'keyboards/facew/readme.md')
-rw-r--r--keyboards/facew/readme.md20
1 files changed, 7 insertions, 13 deletions
diff --git a/keyboards/facew/readme.md b/keyboards/facew/readme.md
index 578dcf8888..b749d18d29 100644
--- a/keyboards/facew/readme.md
+++ b/keyboards/facew/readme.md
@@ -2,20 +2,12 @@
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. It originally uses BootMapperClient for programming but
-can now also use QMK.
+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 Notes
-- The FaceW Sprit Edition can be purchased on [mechanicalkeyboards.com](www.mechanicalkeyboards.com)
-- Uses ps2avru instead of ps2avrgb
-- To put in reset mode hold `q` while inserting the USB cable
-
Make example for this keyboard (after setting up your build environment):
make facew:default
@@ -24,6 +16,8 @@ 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.
@@ -42,12 +36,12 @@ macOS:
```
3. Install the following packages:
```
- brew install python
- brew install pyusb
- brew install --HEAD`https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
+ 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 [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).