summaryrefslogtreecommitdiffstats
path: root/keyboards/binepad/pixie/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/binepad/pixie/readme.md')
-rw-r--r--keyboards/binepad/pixie/readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/binepad/pixie/readme.md b/keyboards/binepad/pixie/readme.md
new file mode 100644
index 0000000000..98287ab97b
--- /dev/null
+++ b/keyboards/binepad/pixie/readme.md
@@ -0,0 +1,27 @@
+# BINEPAD PIXIE
+
+![BINEPAD PIXIE](https://i.imgur.com/OnQnkdUh.jpeg)
+
+*A 2x2 macropad with 2x rotary encoders*
+
+* Keyboard Maintainer: [binepad](https://github.com/binepad)
+* Hardware Supported: BINPAD PIXIE
+* Hardware Availability: [binepad.com](https://www.binepad.com/pixie)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make binepad/pixie:default
+
+Flashing example for this keyboard:
+
+ make binepad/pixie:default:flash
+
+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).
+
+## Bootloader
+
+Enter the bootloader in 3 ways:
+
+* **Bootmagic reset**: Hold down the key at (010) in the matrix (the bottom left key) and plug in the keyboard
+* **Physical reset button**: Briefly press the PCB button located on the back of the PCB
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` or `RESET` if it is available