summaryrefslogtreecommitdiffstats
path: root/keyboards/mtbkeys/mtb60/hotswap/readme.md
diff options
context:
space:
mode:
authorKyle Gieselman <57047887+kgieselman@users.noreply.github.com>2021-11-19 11:02:19 -0500
committerGitHub <noreply@github.com>2021-11-19 08:02:19 -0800
commit58e7527e602395b0e90ed2560c390c3a6b493db2 (patch)
tree11b5fbef43e6ebba6f2b936ad79572011e28599d /keyboards/mtbkeys/mtb60/hotswap/readme.md
parent4f764519ab3fbca7c7f2ac5a8ec5d42ae1968663 (diff)
[Keyboard] Add MTBKeys MTB60 Keyboard (Solderable and Hotswap edition) (#14222)
Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/mtbkeys/mtb60/hotswap/readme.md')
-rw-r--r--keyboards/mtbkeys/mtb60/hotswap/readme.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/keyboards/mtbkeys/mtb60/hotswap/readme.md b/keyboards/mtbkeys/mtb60/hotswap/readme.md
new file mode 100644
index 0000000000..7afa26bbd4
--- /dev/null
+++ b/keyboards/mtbkeys/mtb60/hotswap/readme.md
@@ -0,0 +1,26 @@
+# MTB60 (Hotswap Edition)
+
+## Details
+
+* Keyboard Maintainer: [MTBKeys](https://mtbkeys.com/)
+* Hardware Supported: MTB60 PCB (Hotswap edition)
+* Hardware Availability: [HB60 on MTBKeys Website](https://mtbkeys.com/)
+
+## Building Firmware
+
+Make example for this keyboard (after setting up your build environment):
+
+ make mtbkeys/mtb60/hotswap:default
+
+Flashing example for this keyboard:
+
+ make mtbkeys/mtb60/hotswap:default:flash
+
+## Bootloader
+
+Enter the bootloader in 2 ways:
+
+1. **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
+2. **Physical reset button**: Briefly press the button on the back of the PCB
+
+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).