aboutsummaryrefslogtreecommitdiffstats
path: root/keyboards/swiss/readme.md
diff options
context:
space:
mode:
authorBregoliii2024-03-21 05:04:14 +0100
committerGitHub2024-03-21 05:04:14 +0100
commitd5374b7e017772643b6bf190e105bcdd84f14f98 (patch)
tree54e2e2e67bfd33a5f1ad5dcce310b389911b65c9 /keyboards/swiss/readme.md
parent34374d2e2e4f5b827c8a0402b0cc8f177431e25a (diff)
Add Swiss support (#23272)
Diffstat (limited to 'keyboards/swiss/readme.md')
-rw-r--r--keyboards/swiss/readme.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/keyboards/swiss/readme.md b/keyboards/swiss/readme.md
new file mode 100644
index 0000000000..779f7dcc7f
--- /dev/null
+++ b/keyboards/swiss/readme.md
@@ -0,0 +1,28 @@
+# Swiss
+
+![Swiss](https://i.imgur.com/8G6MB5D.png)
+
+An HHKB that looks like... Cheese?
+A fun, not so serious, ridiculously cheesy keyboard.
+
+* Keyboard Maintainer: [Bregoli](https://geekhack.org/index.php?topic=119509.0)
+* Hardware Supported: Custom HHKB PCB and C3 Unified Daughterboard
+
+Make example for this keyboard (after setting up your build environment):
+
+ make swiss:default
+
+Flashing example for this keyboard:
+
+ make swiss: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