summaryrefslogtreecommitdiffstats
path: root/keyboards/drop/cstm80/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/drop/cstm80/readme.md')
-rw-r--r--keyboards/drop/cstm80/readme.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/keyboards/drop/cstm80/readme.md b/keyboards/drop/cstm80/readme.md
new file mode 100644
index 0000000000..f0851cc045
--- /dev/null
+++ b/keyboards/drop/cstm80/readme.md
@@ -0,0 +1,24 @@
+# CSTM80
+
+The CSTM80 is a tenkeyless keyboard with customizable switch plates and weights, as well as a magnetically attached top case.
+
+* Keyboard Maintainer: [zvecr](https://github.com/zvecr)
+* Hardware Availability: [Drop CSTM80 Mechanical Keyboard](https://drop.com/buy/drop-cstm80-mechanical-keyboard)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make drop/cstm80:default
+
+Flashing example for this keyboard:
+
+ make drop/cstm80: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**: Quickly double tap the button located under the spacebar
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available