summaryrefslogtreecommitdiffstats
path: root/keyboards/mwstudio/alicekk/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/mwstudio/alicekk/readme.md')
-rw-r--r--keyboards/mwstudio/alicekk/readme.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/keyboards/mwstudio/alicekk/readme.md b/keyboards/mwstudio/alicekk/readme.md
new file mode 100644
index 0000000000..f37629e7bb
--- /dev/null
+++ b/keyboards/mwstudio/alicekk/readme.md
@@ -0,0 +1,22 @@
+# AliceKK
+
+![AliceKK](https://i.imgur.com/xfjynwgh.jpeg)
+
+Support STM32F103CBT6 keyboard.
+
+* Keyboard Maintainer: [TW59420](https://github.com/TW59420)
+* Hardware Supported: STM32F103CBT6
+
+Make example for this keyboard (after setting up your build environment):
+
+ make mwstudio/alicekk:default
+
+Flashing example for this keyboard:
+
+ make mwstudio/alicekk: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
+* **Physical reset button**: Short press the button on the back of the PCB to enter the Bootloader and flash the firmware
+* **Keycode in layout**: Press the key mapped to RESET if it is available