keyboards/facew/readme.md

   1 # FaceW
   2
   3 A 60% no frills keyboard.
   4
   5 The FaceW is a special run of the WKL B.Face sourced from Sprit that doesn't have underglow RGB LEDs
   6 but does have in switch LEDs. Also unlike the B.Face, it is based on ps2avru instead of ps2avrGB. It
   7 is designed and manufactured in Korea.  It originally uses BootMapperClient for programming but
   8 can now also use QMK.
   9
  10 Keyboard Maintainer: [MechMerlin](www.github.com/mechmerlin)
  11 Hardware Supported: FaceW Sprit Edition PCB
  12 Hardware Availability: https://mechanicalkeyboards.com/shop/index.php?l=product_detail&p=1352
  13
  14 ## Keyboard Notes
  15 - The FaceW Sprit Edition can be purchased on [mechanicalkeyboards.com](www.mechanicalkeyboards.com)
  16 - Uses ps2avru instead of ps2avrgb
  17 - To put in reset mode hold `q` while inserting the USB cable
  18
  19 Make example for this keyboard (after setting up your build environment):
  20
  21     make facew:default
  22
  23 Flashing
  24
  25 ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods.
  26
  27 Windows:
  28 1. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
  29 2. Place your keyboard into reset.
  30 3. Press the `Find Device` button and ensure that your keyboard is found.
  31 4. Press the `Open .hex File` button and locate the `.hex` file you created.
  32 5. Press the `Flash Device` button and wait for the process to complete.
  33
  34 macOS:
  35 1. Install homebrew by typing the following:
  36     ```
  37     /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
  38     ```
  39 2. Install `crosspack-avr`.
  40     ```
  41     brew cask install crosspack-avr
  42     ```
  43 3. Install the following packages:
  44     ```
  45     brew install python
  46     brew install pyusb
  47     brew install --HEAD`https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
  48
  49 4. Place your keyboard into reset.
  50 5. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file.
  51
  52
  53 See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information.