aboutsummaryrefslogtreecommitdiff
path: root/keyboards/sharkoon/skiller_sgk50_s4/readme.md
diff options
context:
space:
mode:
authorJoy Lee <[email protected]>2024-05-01 14:35:58 +0800
committerGitHub <[email protected]>2024-04-30 23:35:58 -0700
commit719c99afa1a5449edee4453cf5b1bf3c8e75e0eb (patch)
treeb91ca6e9a1169a7694a29dd52b1ac8855e1d29b5 /keyboards/sharkoon/skiller_sgk50_s4/readme.md
parent8129b73d8a79647ab7e0338ab006c58ecb4a958b (diff)
downloadqmk_firmware-719c99afa1a5449edee4453cf5b1bf3c8e75e0eb.tar.gz
qmk_firmware-719c99afa1a5449edee4453cf5b1bf3c8e75e0eb.zip
[Keyboard] Add skiller_sgk50_s4 keyboard (#23636)
Co-authored-by: wb <[email protected]> Co-authored-by: jack <[email protected]> Co-authored-by: Duncan Sutherland <[email protected]>
Diffstat (limited to 'keyboards/sharkoon/skiller_sgk50_s4/readme.md')
-rw-r--r--keyboards/sharkoon/skiller_sgk50_s4/readme.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/keyboards/sharkoon/skiller_sgk50_s4/readme.md b/keyboards/sharkoon/skiller_sgk50_s4/readme.md
new file mode 100644
index 0000000000..db6650546e
--- /dev/null
+++ b/keyboards/sharkoon/skiller_sgk50_s4/readme.md
@@ -0,0 +1,24 @@
+# SHARKOON SKILLER SGK50 S4
+
+![ISO](https://i.imgur.com/4WDIMm0.png)
+
+* Keyboard Maintainer: [JoyLee](https://github.com/itarze)
+* Hardware Supported: [SHARKOON SKILLER SGK50 S4 PCB](http://www.sharkoon.com/)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make sharkoon/skiller_sgk50_s4:default
+
+Flashing example for this keyboard:
+
+ make sharkoon/skiller_sgk50_s4: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