aboutsummaryrefslogtreecommitdiffstats
path: root/keyboards/kwstudio/pisces/readme.md
diff options
context:
space:
mode:
authorkhchen20042023-10-27 08:38:22 +0200
committerGitHub2023-10-27 08:38:22 +0200
commit0ad780f852c725d8e25d0cf2032af9eac5a8ee92 (patch)
tree504bacd046250925c9729715cf6bc0be3ac02564 /keyboards/kwstudio/pisces/readme.md
parentf5cd30458a91aeeb1ac785b562550607c09054d6 (diff)
[Keyboard] add pisces pcb (#22334)
Diffstat (limited to 'keyboards/kwstudio/pisces/readme.md')
-rw-r--r--keyboards/kwstudio/pisces/readme.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/keyboards/kwstudio/pisces/readme.md b/keyboards/kwstudio/pisces/readme.md
new file mode 100644
index 0000000000..29cf8ebf5c
--- /dev/null
+++ b/keyboards/kwstudio/pisces/readme.md
@@ -0,0 +1,25 @@
+# Pisces
+
+![Pisces](https://i.imgur.com/fqEBVD8h.jpeg)
+
+* Keyboard Maintainer: [khchen](https://github.com/khchen2004)
+* Hardware Supported: Pisces PCB
+* Hardware Availability: Private GB
+
+Make example for this keyboard (after setting up your build environment):
+
+ make kwstudio/pisces:default
+
+Flashing example for this keyboard:
+
+ make kwstudio/pisces: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 - some may have pads you must short instead
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available