summaryrefslogtreecommitdiffstats
path: root/keyboards/helix/rev2/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/helix/rev2/readme.md')
-rw-r--r--keyboards/helix/rev2/readme.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/keyboards/helix/rev2/readme.md b/keyboards/helix/rev2/readme.md
new file mode 100644
index 0000000000..e6a6f2e952
--- /dev/null
+++ b/keyboards/helix/rev2/readme.md
@@ -0,0 +1,13 @@
+# Helix rev2
+
+A compact split ortholinear keyboard.
+
+* Keyboard Maintainer: [yushakobo](https://github.com/yushakobo)
+* Hardware Supported: Helix rev2 PCBs, Pro Micro
+* Hardware Availability: [PCB & Case Data](https://github.com/MakotoKurauchi/helix)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make helix/rev2: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).