summaryrefslogtreecommitdiff
path: root/keyboards/butterkeebs/pocketpad/readme.md
diff options
context:
space:
mode:
authorbutterkeebs <124812866+butterkeebs@users.noreply.github.com>2023-04-02 18:50:14 +0100
committerGitHub <noreply@github.com>2023-04-02 11:50:14 -0600
commitb5d0c4469067ca81e3a8a60fc349f5ad6d92c363 (patch)
treed9addc473bcec68d21dd2ffabd078e050c2afa93 /keyboards/butterkeebs/pocketpad/readme.md
parentd0e0b9e583447fe3e8cc3d6dde3b839ceb1972b3 (diff)
[Keyboard] Add pocketpad (#20229)
Co-authored-by: jack <0x6a73@protonmail.com>
Diffstat (limited to 'keyboards/butterkeebs/pocketpad/readme.md')
-rw-r--r--keyboards/butterkeebs/pocketpad/readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/butterkeebs/pocketpad/readme.md b/keyboards/butterkeebs/pocketpad/readme.md
new file mode 100644
index 0000000000..0af8b7a3c6
--- /dev/null
+++ b/keyboards/butterkeebs/pocketpad/readme.md
@@ -0,0 +1,27 @@
+# PocketPad
+
+![PocketPad](https://tinyurl.com/2hffvnvb)
+
+*The PocketPad is a tiny 18 key macropad/numpad using 6mm tactile switches.*
+
+* Keyboard Maintainer: [ButterKeebs](https://github.com/butterkeebs)
+* Hardware Supported: *Supports current V1.0.0 PocketPad PCB and Elite C / pin compatible MCU boards.*
+* Hardware Availability: *Currently not for sale*
+
+Make example for this keyboard (after setting up your build environment):
+
+ make butterkeebs/pocketpad:default
+
+Flashing example for this keyboard:
+
+ make butterkeebs/pocketpad: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. (Not available on Revision 1.0.0 PCB)
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available