]> git.donarmstrong.com Git - qmk_firmware.git/blob - keyboards/winkeyless/bface/README.md
bface refactor (#6333)
[qmk_firmware.git] / keyboards / winkeyless / bface / README.md
1 # B.face
2
3 A 60% keyboard with RGB that runs ps2avrgb natively. Please note that the B.face and B.fake have different switch matrices. Firmware on one, will not work on the other. 
4
5 Keyboard Maintainer: QMK Community  
6 Hardware Supported: B.face PCB   
7 Hardware Availability: [Winkeyless](https://winkeyless.kr/product/b-face-x2-pcb/)   
8
9 Make example for this keyboard (after setting up your build environment):
10
11     make winkeyless/bface:default
12
13 Flashing
14
15 ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods. 
16
17 **Reset Key:** Hold down the key located at K00, commonly programmed as left control while plugging in the keyboard.
18
19 Windows: 
20 1. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
21 2. Place your keyboard into reset. 
22 3. Press the `Find Device` button and ensure that your keyboard is found.
23 4. Press the `Open .hex File` button and locate the `.hex` file you created.
24 5. Press the `Flash Device` button and wait for the process to complete. 
25
26 macOS:
27 1. Install homebrew by typing the following:   
28     ```
29     /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
30     ```
31 2. Install `crosspack-avr`.  
32     ```
33     brew cask install crosspack-avr
34     ```
35 3. Install the following packages:
36     ```
37     brew install python
38     pip3 install pyusb
39     brew install --HEAD`https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
40     ```
41
42 4. Place your keyboard into reset. 
43 5. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file. 
44
45
46 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).