aboutsummaryrefslogtreecommitdiff
path: root/keyboards/idyllic/pizzapad/readme.md
diff options
context:
space:
mode:
authorDanny Tan <[email protected]>2024-11-09 15:21:52 +1100
committerGitHub <[email protected]>2024-11-08 21:21:52 -0700
commitfb3a414a4042006fd374602931c2b9c943059aa8 (patch)
treebc442c88a2445d6d79686db009dd2043df84ce8c /keyboards/idyllic/pizzapad/readme.md
parente31eeb85db481f977dbe7d6d2d9007a9faaeaf3e (diff)
downloadqmk_firmware-fb3a414a4042006fd374602931c2b9c943059aa8.tar.gz
qmk_firmware-fb3a414a4042006fd374602931c2b9c943059aa8.zip
Add Idyllic Pizza Pad (#24566)
* Initial PizzaPad firmware * Updated files to conform to PR checklist * Fix default keymap location * Update keyboard.json * Apply suggestions from code review Co-authored-by: Joel Challis <[email protected]> * Update keyboards/idyllic/pizzapad/keymaps/default/keymap.c Co-authored-by: jack <[email protected]> --------- Co-authored-by: Joel Challis <[email protected]> Co-authored-by: jack <[email protected]>
Diffstat (limited to 'keyboards/idyllic/pizzapad/readme.md')
-rw-r--r--keyboards/idyllic/pizzapad/readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/idyllic/pizzapad/readme.md b/keyboards/idyllic/pizzapad/readme.md
new file mode 100644
index 0000000000..04098cb522
--- /dev/null
+++ b/keyboards/idyllic/pizzapad/readme.md
@@ -0,0 +1,27 @@
+# Pizza Pad PCB
+
+![Pizza Pad PCB](https://i.imgur.com/eJLuaZY.jpg)
+
+A 3x3 PCB designed for the Idyllic Pretty Pad.
+
+* Keyboard Maintainer: Zykrah
+* Hardware Supported: Pizza Pad PCB (using a SEEED XIAO RP2040)
+* Hardware Availability: [Mechstock](https://mechstock.com.au/)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make idyllic/pizzapad:default
+
+Flashing example for this keyboard:
+
+ make idyllic/pizzapad: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 both the `BOOT` and `RESET` buttons at the same time
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available