summaryrefslogtreecommitdiff
path: root/keyboards/p3d/glitch/readme.md
diff options
context:
space:
mode:
authorMatthew Dias <matthewdias@me.com>2022-03-13 01:36:12 -0600
committerGitHub <noreply@github.com>2022-03-12 23:36:12 -0800
commit20424fd37f84cbe08740539a48b6bb4839e0a179 (patch)
tree3236d40a5df923b13568355d7e17621caffcd207 /keyboards/p3d/glitch/readme.md
parent86b123141bea2e3f831a57eb115368cbbbdb2da1 (diff)
[Keyboard] Add Glitch (#16444)
Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/p3d/glitch/readme.md')
-rw-r--r--keyboards/p3d/glitch/readme.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/keyboards/p3d/glitch/readme.md b/keyboards/p3d/glitch/readme.md
new file mode 100644
index 0000000000..b29dc6e930
--- /dev/null
+++ b/keyboards/p3d/glitch/readme.md
@@ -0,0 +1,24 @@
+# Glitch
+
+Hotswap RGB Alice-style with OLED and Rotary Knob
+
+- Keyboard Maintainer: matthewdias
+- Hardware Supported: Glitch PCB
+- Hardware Availability: https://p3dstore.com
+
+Make example for this keyboard (after setting up your build environment):
+
+ make p3d/glitch:default
+
+Flashing example for this keyboard:
+
+ make p3d/glitch:default:flash
+
+## Bootloader
+
+Enter the bootloader in one of 2 ways:
+
+* **Bootmagic reset**: Hold down the top left and plug in the keyboard
+* **Physical reset button**: Briefly press the button on the top of the PCB
+
+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).