diff options
Diffstat (limited to 'keyboards/mode/m80v2/readme.md')
| -rw-r--r-- | keyboards/mode/m80v2/readme.md | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/keyboards/mode/m80v2/readme.md b/keyboards/mode/m80v2/readme.md new file mode 100644 index 000000000..e94984f06 --- /dev/null +++ b/keyboards/mode/m80v2/readme.md | |||
| @@ -0,0 +1,38 @@ | |||
| 1 | # Mode Eighty V2 PCB QMK firmware | ||
| 2 | |||
| 3 | \ | ||
| 4 | [Image Gallery](https://imgur.com/t/mechanicalkeyboards/8Uf6c2m?nc=1) | ||
| 5 | |||
| 6 | The Mode80 is a tenkeyless high-end keyboard sold by [Mode Designs](https://shop.modedesigns.com/). | ||
| 7 | |||
| 8 | * Keyboard Maintainer: [Gondolindrim](https://github.com/gondolindrim) | ||
| 9 | * Hardware Supported: proprietary PCB using STM32F072 controller | ||
| 10 | * Hardware Availability: you can get a Mode Eighty as of today (dec. 2021) through the in stock sales or special groupbuy editions at https://shop.modedesigns.com/ | ||
| 11 | |||
| 12 | ## How to flash | ||
| 13 | |||
| 14 | ### Enter bootloader | ||
| 15 | |||
| 16 | The DFU state in the bootloader can be accessed in 3 ways: | ||
| 17 | |||
| 18 | * **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard | ||
| 19 | * **Physical reset button**: press the button on the front of the PCB, next to caps lock, for at least five seconds | ||
| 20 | * **Keycode in layout**: Press the key mapped to `RESET` if it is available (ESC key at layer 1 in the default layout) | ||
| 21 | |||
| 22 | ## Compile firmware | ||
| 23 | |||
| 24 | After accessing the DFU state in your PCB, build the default layout using: | ||
| 25 | |||
| 26 | make mode/m80v2/m80v2h:default # Hotswap | ||
| 27 | make mode/m80v2/m80v2s:default # Soldered | ||
| 28 | |||
| 29 | Then download the resulting binary `*bin` file using `dfu-util` or QMK Toolbox. | ||
| 30 | |||
| 31 | ## Compile and flash | ||
| 32 | |||
| 33 | After accessing the DFU state in your PCB, you can compile-and-flash automatically usind `dfu-util` through | ||
| 34 | |||
| 35 | make mode/m80v2/m80v2h:default:flash # Hotswap | ||
| 36 | make mode/m80v2/m80v2s:default:flash # Soldered | ||
| 37 | |||
| 38 | 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). | ||
