summaryrefslogtreecommitdiff
path: root/keyboards/ms_sculpt/readme.md
diff options
context:
space:
mode:
authorJean Bernard <105235786+jn-bernard@users.noreply.github.com>2022-07-02 14:16:38 +0200
committerGitHub <noreply@github.com>2022-07-02 22:16:38 +1000
commitef633cf46139282daaca77939937f7ba2519f56b (patch)
tree65db8b7f9cd31f5a92a6567d54d77259086ac6c6 /keyboards/ms_sculpt/readme.md
parent9c2505676caa22a17c25ac29230d4faed948b71e (diff)
Added MS Sculpt ISO-layout conversion with STM32F401 (#17049)
Diffstat (limited to 'keyboards/ms_sculpt/readme.md')
-rw-r--r--keyboards/ms_sculpt/readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/ms_sculpt/readme.md b/keyboards/ms_sculpt/readme.md
new file mode 100644
index 0000000000..0b0c500664
--- /dev/null
+++ b/keyboards/ms_sculpt/readme.md
@@ -0,0 +1,27 @@
+# ms_sculpt
+
+![ms_sculpt_with_cold_dry_joints](https://user-images.githubusercontent.com/105235786/168012266-4e235bf5-8d34-4731-ab17-2308a9d9a29e.jpg)
+
+MS Sculpt Keyboard ISO-layout wired to STM32F401 / blackpill
+
+* Keyboard Maintainer: [Jean Bernard](https://github.com/jn-bernard)
+* Hardware Supported: MS Sculpt Keyboard ISO-layout, STM32F401
+* Hardware Availability: Ebay
+
+Make example for this keyboard (after setting up your build environment):
+
+ make ms_sculpt:default
+
+Flashing example for this keyboard:
+
+ make ms_sculpt: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 `RESET` if it is available