summaryrefslogtreecommitdiff
path: root/keyboards/gummykey/readme.md
diff options
context:
space:
mode:
authorgumorr <102767971+gumorr@users.noreply.github.com>2023-03-06 13:17:29 -0600
committerGitHub <noreply@github.com>2023-03-06 11:17:29 -0800
commitca5eb9f664cd58cf4e396c54f5fc16c44224fdea (patch)
treeb190cdaca9fab96c02dc730d23cdad8de4ac9909 /keyboards/gummykey/readme.md
parent61f3f5676a1f4ba31ad9ed7bdcba164178230275 (diff)
[Keyboard] Add gummykey (#19695)
Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: jack <0x6a73@protonmail.com>
Diffstat (limited to 'keyboards/gummykey/readme.md')
-rw-r--r--keyboards/gummykey/readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/gummykey/readme.md b/keyboards/gummykey/readme.md
new file mode 100644
index 0000000000..80558ee330
--- /dev/null
+++ b/keyboards/gummykey/readme.md
@@ -0,0 +1,27 @@
+# GummyKey
+
+![gummykey](https://i.imgur.com/R6ffs2Bh.png)
+
+a 4x6+5 split keyboard i made
+
+* Keyboard Maintainer: [Gummor](https://github.com/gumorr)
+* Hardware Supported: Pro Micro
+* Hardware Availability: [Github](https://github.com/gumorr/GummyKey)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make gummykey:default
+
+Flashing example for this keyboard:
+
+ make gummykey: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 (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
+* **Physical reset button**: Briefly press the button on the back of the PCB - some may have pads you must short instead
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available \ No newline at end of file