aboutsummaryrefslogtreecommitdiffstats
path: root/keyboards/mschwingen/modelm/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/mschwingen/modelm/README.md')
-rw-r--r--keyboards/mschwingen/modelm/README.md25
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 @@
+# atmega32U4 board for IBM Model M
+
+![modelm](https://raw.githubusercontent.com/mschwingen/hardware/master/modelm-usb/images/PCB.jpg)
+
+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).
+
+* Keyboard Maintainer: [Michael Schwingen](https://github.com/mschwingen/)
+* Hardware Supported: [Model M USB PCB](https://github.com/mschwingen/hardware/tree/master/modelm-usb)
+* Hardware Availability: need to build your own.
+
+Make example for this keyboard (after setting up your build environment), run one of:
+
+ make mschwingen/modelm/led_wired:default
+ make mschwingen/modelm/led_ffc:default
+ make mschwingen/modelm/led_ws2812:default
+
+flash:
+
+ make mschwingen/modelm/led_wired:default:flash
+ make mschwingen/modelm/led_ffc:default:flash
+ make mschwingen/modelm/led_ws2812:default:flash
+
+Bootloader: do not use the QMK bootloader, use the bootloader from [here](https://github.com/mschwingen/modelm-lufa-bootloader)
+
+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).