summaryrefslogtreecommitdiffstats
path: root/keyboards/kb_elmo/twelvekey/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/kb_elmo/twelvekey/readme.md')
-rw-r--r--keyboards/kb_elmo/twelvekey/readme.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/keyboards/kb_elmo/twelvekey/readme.md b/keyboards/kb_elmo/twelvekey/readme.md
new file mode 100644
index 0000000000..db24063783
--- /dev/null
+++ b/keyboards/kb_elmo/twelvekey/readme.md
@@ -0,0 +1,19 @@
+# Twelvekey
+
+![twelvekey](https://i.imgur.com/xBQIvpml.png)
+
+Simple 12-key macropad
+
+* Keyboard Maintainer: [kb-elmo](https://github.com/kb-elmo)
+* Hardware Supported: Twelvekey PCB with backlight
+* Hardware Availability: [Open source project](https://github.com/kb-elmo/twelvekey)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make kb_elmo/twelvekey:default
+
+Flashing example for this keyboard:
+
+ make kb_elmo/twelvekey:default:flash
+
+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).