summaryrefslogtreecommitdiff
path: root/keyboards/jacky_studio/piggy60/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/jacky_studio/piggy60/readme.md')
-rw-r--r--keyboards/jacky_studio/piggy60/readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/jacky_studio/piggy60/readme.md b/keyboards/jacky_studio/piggy60/readme.md
new file mode 100644
index 0000000000..d546c63bf8
--- /dev/null
+++ b/keyboards/jacky_studio/piggy60/readme.md
@@ -0,0 +1,27 @@
+# Piggy60
+
+![piggy60](https://i.imgur.com/QXuKDual.jpg)
+
+A gasket-mounted 60% in the style of the S7 Elephant.
+
+* Keyboard Maintainer: [The QMK Community](https://github.com/qmk)
+* Hardware Supported: Piggy60
+* Hardware Availability: Group Buy took place between 2021-05-22 1600 UTC and 2021-05-25 1600 UTC on [https://jackylab.com/](https://jackylab.com/).
+
+Make example for this keyboard (after setting up your build environment):
+
+ make jacky_studio/piggy60:default
+
+Flashing example for this keyboard:
+
+ make jacky_studio/piggy60: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 top left key and plug in the keyboard. This will also clear EEPROM, so it is a good first step if the keyboard is misbehaving.
+* **Physical reset**: Short the set of vertical holes on the third row, to the right of Caps Lock. These can be reached with tweezers after the board has been assembled.
+* **Keycode in layout**: There is no key mapped to `QK_BOOT` in the pre-created keymaps, but you may assign this key in any keymaps you create.