summaryrefslogtreecommitdiff
path: root/keyboards/winkeyless/bface/readme.md
diff options
context:
space:
mode:
authorErovia <Erovia@users.noreply.github.com>2020-10-25 15:23:42 +0000
committerGitHub <noreply@github.com>2020-10-25 15:23:42 +0000
commitad86894ae7d5fbb7aed697d9f576cd186bfd1c9c (patch)
treec5ffe570301b95699d93566d5b9453bda203a7ae /keyboards/winkeyless/bface/readme.md
parentaf455a8368dc564df51f9657b04932956ccf580b (diff)
Rename keyboard-level readmes to lower-case (#10759)
This is the recommendation in the [PR Checklist](https://docs.qmk.fm/#/pr_checklist?id=keyboard-prs) and it will make working with them easier in the CLI/API/etc.
Diffstat (limited to 'keyboards/winkeyless/bface/readme.md')
-rw-r--r--keyboards/winkeyless/bface/readme.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/keyboards/winkeyless/bface/readme.md b/keyboards/winkeyless/bface/readme.md
new file mode 100644
index 0000000000..ab39a97db0
--- /dev/null
+++ b/keyboards/winkeyless/bface/readme.md
@@ -0,0 +1,19 @@
+# B.face
+
+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.
+
+* Keyboard Maintainer: QMK Community
+* Hardware Supported: B.face PCB
+* Hardware Availability: [Winkeyless](https://winkeyless.kr/product/b-face-x2-pcb/)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make winkeyless/bface:default
+
+Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
+
+ make winkeyless/bface:default:flash
+
+**Reset Key**: Hold down the key located at *K00*, commonly programmed as *left control* while plugging in the keyboard.
+
+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).