diff options
Diffstat (limited to 'keyboards/mschwingen/modelm/readme.md')
| -rw-r--r-- | keyboards/mschwingen/modelm/readme.md | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/keyboards/mschwingen/modelm/readme.md b/keyboards/mschwingen/modelm/readme.md new file mode 100644 index 000000000..f4cb36062 --- /dev/null +++ b/keyboards/mschwingen/modelm/readme.md | |||
| @@ -0,0 +1,25 @@ | |||
| 1 | # atmega32U4 board for IBM Model M | ||
| 2 | |||
| 3 |  | ||
| 4 | |||
| 5 | This is a configuration of QMK intended to be used with the [Model M USB PCB](https://github.com/mschwingen/hardware/tree/master/modelm-usb). | ||
| 6 | |||
| 7 | * Keyboard Maintainer: [Michael Schwingen](https://github.com/mschwingen/) | ||
| 8 | * Hardware Supported: [Model M USB PCB](https://github.com/mschwingen/hardware/tree/master/modelm-usb) | ||
| 9 | * Hardware Availability: need to build your own. | ||
| 10 | |||
| 11 | Make example for this keyboard (after setting up your build environment), run one of: | ||
| 12 | |||
| 13 | make mschwingen/modelm/led_wired:default | ||
| 14 | make mschwingen/modelm/led_ffc:default | ||
| 15 | make mschwingen/modelm/led_ws2812:default | ||
| 16 | |||
| 17 | flash: | ||
| 18 | |||
| 19 | make mschwingen/modelm/led_wired:default:flash | ||
| 20 | make mschwingen/modelm/led_ffc:default:flash | ||
| 21 | make mschwingen/modelm/led_ws2812:default:flash | ||
| 22 | |||
| 23 | Bootloader: do not use the QMK bootloader, use the bootloader from [here](https://github.com/mschwingen/modelm-lufa-bootloader) | ||
| 24 | |||
| 25 | 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). | ||
