summaryrefslogtreecommitdiff
path: root/keyboards/work_louder/numpad/readme.md
diff options
context:
space:
mode:
authorDrashna Jaelre <drashna@live.com>2022-11-05 10:55:42 -0700
committerGitHub <noreply@github.com>2022-11-05 17:55:42 +0000
commite3a97eb1c8b97ff37412913e53f34cb7918497f1 (patch)
tree24a9a51cb69ae06ee5aa03a06c446b5c6d6fb362 /keyboards/work_louder/numpad/readme.md
parent7fe76e53c1e7c1569a99b6dbf3eee11aad3df094 (diff)
[Keyboard] Add Work Louder Numpad (#18912)
* [Keyboard] Add Work Louder Numpad * Add future proofing for rgb matrix * Update readme * fixup copyright headers * Actually enable via
Diffstat (limited to 'keyboards/work_louder/numpad/readme.md')
-rw-r--r--keyboards/work_louder/numpad/readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/work_louder/numpad/readme.md b/keyboards/work_louder/numpad/readme.md
new file mode 100644
index 0000000000..a7e6b488da
--- /dev/null
+++ b/keyboards/work_louder/numpad/readme.md
@@ -0,0 +1,27 @@
+# Work Louder Num Pad
+
+![work_louder/numpad](https://worklouder.cc/wp-content/uploads/2022/08/Numpad-WP.png)
+
+*An ATmega32u4 based 4x4 number pad with per key and underglow RGB*
+
+* Keyboard Maintainer: [Drashna Jael're](https://github.com/drashna)
+* Hardware Supported: An ATmega32u4 based 4x4 number pad with per key and underglow RGB
+* Hardware Availability: [Work Louder](https://shop.worklouder.cc/)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make work_louder/numpad:default
+
+Flashing example for this keyboard:
+
+ make work_louder/numpad: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
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available