summaryrefslogtreecommitdiffstats
path: root/keyboards/ashpil/modelm_usbc/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/ashpil/modelm_usbc/README.md')
-rw-r--r--keyboards/ashpil/modelm_usbc/README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/keyboards/ashpil/modelm_usbc/README.md b/keyboards/ashpil/modelm_usbc/README.md
new file mode 100644
index 0000000000..261d97ab49
--- /dev/null
+++ b/keyboards/ashpil/modelm_usbc/README.md
@@ -0,0 +1,14 @@
+# USB C Model M
+
+![modelm_usbc](https://raw.githubusercontent.com/ashpil/Model-M-Type-C-Controller/master/images/render.png)
+
+This is a configuration of QMK intended to be used with the [USB C Model M alt controller](https://github.com/ashpil/Model-M-Type-C-Controller "USB C Model M alt controller"). Many thanks to iw0rm3r for working on a similar project and providing the foundation for this!
+
+* Keyboard Maintainer: [ashpil](https://github.com/ashpil)
+* Hardware Supported: [USB C Model M alt controller](https://github.com/ashpil/Model-M-Type-C-Controller)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make ashpil/modelm_usbc: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).