summaryrefslogtreecommitdiff
path: root/keyboards/gkeyboard/greatpad/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/gkeyboard/greatpad/readme.md')
-rw-r--r--keyboards/gkeyboard/greatpad/readme.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/keyboards/gkeyboard/greatpad/readme.md b/keyboards/gkeyboard/greatpad/readme.md
new file mode 100644
index 0000000000..d8a0443d2b
--- /dev/null
+++ b/keyboards/gkeyboard/greatpad/readme.md
@@ -0,0 +1,25 @@
+# GreatPad
+
+20 Keys Custom Macro Pad, 2 Encoders, OLED 128x64, with USB Type-C, RGB underglow, RGB Per Key Lighting.
+
+* Keyboard Maintainer: [gkeyboard](https://github.com/gkeyboard)
+* Hardware Supported: GreatPad PCB
+* Hardware Availability: http://www.mltelectronic.com
+
+Make example for this keyboard (after setting up your build environment):
+
+ make gkeyboard/greatpad:default
+
+Flashing example for this keyboard:
+
+ make gkeyboard/greatpad: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 boot button**: Hold down the boot button on RP2040 and plug in the keyboard
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available