summaryrefslogtreecommitdiff
path: root/keyboards/helix/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/helix/readme.md')
-rw-r--r--keyboards/helix/readme.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/keyboards/helix/readme.md b/keyboards/helix/readme.md
new file mode 100644
index 000000000..5ee233e81
--- /dev/null
+++ b/keyboards/helix/readme.md
@@ -0,0 +1,16 @@
+Helix
+===
+
+![Helix](https://i.imgur.com/XBAmynN.jpg)
+
+A compact split ortholinear keyboard.
+
+Keyboard Maintainer: [Makoto Kurauchi](https://github.com/MakotoKurauchi/) [@pluis9](https://twitter.com/pluis9)
+Hardware Supported: Helix PCB Alpha, Beta, Pro Micro
+Hardware Availability: [PCB & Case Data](https://github.com/MakotoKurauchi/helix), [Yushakobo Shop](https://yushakobo.jp/shop/)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make helix:default
+
+See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information.