summaryrefslogtreecommitdiffstats
path: root/keyboards/mode/m256wh/readme.md
diff options
context:
space:
mode:
authorQMK Bot <hello@qmk.fm>2023-07-11 03:50:51 +0000
committerQMK Bot <hello@qmk.fm>2023-07-11 03:50:51 +0000
commite3d873ee1e25644b8440d0c72768995b2d8718d0 (patch)
tree202ceefbd1eef9118439b0bbf8e33ef067817a6d /keyboards/mode/m256wh/readme.md
parentfcb1a049e6ff265da9b5aa7c38652d1ba0e3005b (diff)
parent4d92aff2aeed79f6b0c792a5b75744c5dc1049cd (diff)
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'keyboards/mode/m256wh/readme.md')
-rw-r--r--keyboards/mode/m256wh/readme.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/keyboards/mode/m256wh/readme.md b/keyboards/mode/m256wh/readme.md
new file mode 100644
index 0000000000..8b253f427e
--- /dev/null
+++ b/keyboards/mode/m256wh/readme.md
@@ -0,0 +1,25 @@
+# Mode M256-WH PCB QMK Firmware
+
+![m256wh](https://imgur.com/97KRZCrh.jpg)
+
+The M256-WH is the hotswap version PCB support for the Mode Envoy.
+
+* Keyboard Maintainer: [Gondolindrim](https://github.com/Gondolindrim)
+* Hardware Supported: proprietary PCBs using the STM32F401 microcontroller;
+* Hardware Availability: as of april 18, these PCBs are on the verge of being sold with the first kits of the Mode Envoy.
+
+## How to flash
+
+In order to flash this PCB, first build the default layout (after setting up your build environment):
+
+ make mode/m256wh:default
+
+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**: press the button on the back of the PCB for at least five seconds
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available (escape key, layer 1 of the default keymap)