summaryrefslogtreecommitdiffstats
path: root/keyboards/bear_face/readme.md
diff options
context:
space:
mode:
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 0000000000..f81214ce82
--- /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).