aboutsummaryrefslogtreecommitdiffstats
path: root/keyboards/bear_face/readme.md
diff options
context:
space:
mode:
authorGravatar chemicalwill <36576135+chemicalwill@users.noreply.github.com>2020-03-31 16:46:20 -0500
committerGravatar GitHub <noreply@github.com>2020-03-31 14:46:20 -0700
commit4434649c2f33a886d5b4e331b33daa8d1f430f7f (patch)
treea75da551900807fb570a6070bdec19fd0bfa7d95 /keyboards/bear_face/readme.md
parentc6c94eeabcf2681b6f0c72de76ba0b94e4c6d4d3 (diff)
downloadqmk_firmware-4434649c2f33a886d5b4e331b33daa8d1f430f7f.tar.gz
[Keyboard] added bear_face PCB (#8596)
* bear_face initial commit Added bear_face PCB * ATMega32u4-based replacement PCB for the Vortex Race 3 * Default keymap emulates stock board keymap (with a few changes), including layer toggles for QWERTY, COLEMAK, and DVORAK layouts * Suggested changes made * fixed keyboard_pre_init_kb in bear_face.c * removed 'LAYOUTS = 83_ansi' from rules.mk * readme header fixed Co-Authored-By: Ryan <fauxpark@gmail.com> * rules.mk formatting fixed Co-Authored-By: Ryan <fauxpark@gmail.com> * info.json converted from KLE * Default layers enum added Co-Authored-By: Drashna Jaelre <drashna@live.com> * Specified LAYOUT_83_ansi in info.json from generic LAYOUT Co-Authored-By: Joel Challis <git@zvecr.com> * Updated license * Changed license name to username * Changed license email to github profile url Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Joel Challis <git@zvecr.com>
Diffstat (limited to 'keyboards/bear_face/readme.md')
-rw-r--r--keyboards/bear_face/readme.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/keyboards/bear_face/readme.md b/keyboards/bear_face/readme.md
new file mode 100644
index 000000000..f81214ce8
--- /dev/null
+++ b/keyboards/bear_face/readme.md
@@ -0,0 +1,15 @@
+# bear_face
+
+![bear_face](https://i.imgur.com/nQIyP6w.png)
+
+Vortex Race 3 with replacement QMK-compatible PCB designed by [chemicalwill](https://github.com/chemicalwill)
+
+* Keyboard Maintainer: [Will Hedges](https://github.com/chemicalwill)
+* Hardware Supported: bear_face v1.0, atmega32u4
+* Hardware Availability: [PCB files](https://github.com/chemicalwill/bear_face)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make bear_face:default
+
+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).