summaryrefslogtreecommitdiff
path: root/keyboards/gkeyboard/greatpad/readme.md
diff options
context:
space:
mode:
authorgkeyboard <giggox_man@hotmail.com>2024-02-02 23:01:10 +0700
committerGitHub <noreply@github.com>2024-02-02 09:01:10 -0700
commite97ec68692ffee20e92921e7c913471359cd5377 (patch)
tree44105f1173a0d0f23491b1801048913fef133368 /keyboards/gkeyboard/greatpad/readme.md
parent39f06c3afb2a59d04bfc1e5ef52020bfd4e68f84 (diff)
Add GreatPad macropad under gkeyboard (#22696)
* Add GreatPad under gkeyboard Add GreatPad macropad * Update keyboards/gkeyboard/greatpad/config.h Co-authored-by: jack <0x6a73@protonmail.com> * Update keyboards/gkeyboard/greatpad/greatpad.c Co-authored-by: jack <0x6a73@protonmail.com> * Update keyboards/gkeyboard/greatpad/info.json Co-authored-by: jack <0x6a73@protonmail.com> * Update keyboards/gkeyboard/greatpad/info.json Co-authored-by: jack <0x6a73@protonmail.com> * Update keyboards/gkeyboard/greatpad/keymaps/default/keymap.c Co-authored-by: jack <0x6a73@protonmail.com> * Update keyboards/gkeyboard/greatpad/keymaps/default/keymap.c Co-authored-by: jack <0x6a73@protonmail.com> * Update keyboards/gkeyboard/greatpad/keymaps/via/keymap.c Co-authored-by: jack <0x6a73@protonmail.com> * Update keyboards/gkeyboard/greatpad/keymaps/via/keymap.c Co-authored-by: jack <0x6a73@protonmail.com> * Add a license header Add a license header to glcdfont.c * Update glcdfont.c * delete file * Revert "delete file" This reverts commit 388e6f03e47bd646df374e37cd82fc3c46330b38. * Update keyboards/gkeyboard/greatpad/mcuconf.h Co-authored-by: jack <0x6a73@protonmail.com> * Update .vscode/settings.json Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/gkeyboard/greatpad/readme.md Co-authored-by: Ryan <fauxpark@gmail.com> * Enable encoder Enable encoder in file info.json * Update keyboards/gkeyboard/greatpad/greatpad.c Co-authored-by: Drashna Jaelre <drashna@live.com> * Update info.json Run qmk format-json -i file info.json --------- Co-authored-by: jack <0x6a73@protonmail.com> Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Drashna Jaelre <drashna@live.com>
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