aboutsummaryrefslogtreecommitdiff
path: root/keyboards/ymdk/bface/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/ymdk/bface/README.md')
-rw-r--r--keyboards/ymdk/bface/README.md46
1 files changed, 6 insertions, 40 deletions
diff --git a/keyboards/ymdk/bface/README.md b/keyboards/ymdk/bface/README.md
index f6a703bec..04ba680de 100644
--- a/keyboards/ymdk/bface/README.md
+++ b/keyboards/ymdk/bface/README.md
@@ -1,55 +1,21 @@
1# The YMDK "Bface" PCB 1# The YMDK Bface
2 2
3![ymdk_bface](https://i.imgur.com/qhFxN0g.jpg) 3![ymdk_bface](https://i.imgur.com/qhFxN0g.jpg)
4 4
5A 60% keyboard that runs ps2avrgb natively and fits the popular GH60 form factor. Another "bfake" or clone of the original B.face PCB by [Winkeyless](https://winkeyless.kr/product/b-face-x2-pcb/). This PCB has slightly different switch matrix than the origninal B.face, and is also different than the bfake. It commonly comes as the PCB in 60% keyboard kits sold by YMDK on Aliexpress. 5A 60% keyboard that runs ps2avrgb natively and fits the popular GH60 form factor. Another "bfake" or clone of the original B.face PCB by [Winkeyless](https://winkeyless.kr/product/b-face-x2-pcb/). This PCB has slightly different switch matrix than the origninal B.face, and is also different than the bfake. It commonly comes as the PCB in 60% keyboard kits sold by YMDK on Aliexpress.
6 6
7Keyboard Maintainer: QMK Community 7* Keyboard Maintainer: QMK Community
8Hardware Supported: White Bface Mini USB PCB with no RGB. 8* Hardware Supported: White Bface Mini USB PCB with no RGB.
9Hardware Availability: [Shenzhen YMD Tech Co. (YMDK) on Aliexpress](https://www.aliexpress.com/item/32799437588.html) 9* Hardware Availability: [Shenzhen YMD Tech Co. (YMDK) on Aliexpress](https://www.aliexpress.com/item/32799437588.html)
10 10
11Make example for this keyboard (after setting up your build environment): 11Make example for this keyboard (after setting up your build environment):
12 12
13 make ymdk/bface:default 13 make ymdk/bface:default
14 14
15Flashing: 15Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
16 16
17ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods. 17 make ymdk/bface:default:flash
18 18
19This board has a pair of jumper holes on the left edge of the PCB marked "Jb", near TAB and CAPS LOCK. If you short the contacts with tweezers or wire the board will enter into the bootloader and you can flash it. 19This board has a pair of jumper holes on the left edge of the PCB marked "Jb", near TAB and CAPS LOCK. If you short the contacts with tweezers or wire the board will enter into the bootloader and you can flash it.
20 20
21Windows:
221. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
232. Place your keyboard into reset.
243. Press the `Find Device` button and ensure that your keyboard is found.
254. Press the `Open .hex File` button and locate the `.hex` file you created.
265. Press the `Flash Device` button and wait for the process to complete.
27
28macOS:
291. Install homebrew by typing the following:
30 ```
31 /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
32 ```
332. Install `crosspack-avr`.
34 ```
35 brew cask install crosspack-avr
36 ```
373. Install the following packages:
38 ```
39 brew install python
40 pip3 install pyusb
41 brew install --HEAD`https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
42 ```
43
444. Place your keyboard into reset by shorting the jumper on the left edge of the PCB..
455. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file.
46
47Another method for Mac or Linux:
48After installing `bootloadHID`, you can use the `./util/atmega32a_program.py` program included in QMK. You will need to have `python` and the `pyusb` library installed.
49
50Then you can run this to compile the firmware and flash the board without using the jumper:
51```
52make ymdk/bface:default:program
53```
54
55See 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). 21See 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).