summaryrefslogtreecommitdiff
path: root/keyboards/phoenix/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/phoenix/readme.md')
-rw-r--r--keyboards/phoenix/readme.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/keyboards/phoenix/readme.md b/keyboards/phoenix/readme.md
new file mode 100644
index 0000000000..a39f52359b
--- /dev/null
+++ b/keyboards/phoenix/readme.md
@@ -0,0 +1,15 @@
+# Phoenix
+
+![Phoenix](https://imgur.com/adJiuMHl.jpg)
+
+A reborn version of Ergodox with several improved features. [More info on ErgoKB](https://www.ergokb.tw/)
+
+* Keyboard Maintainer: [lschyi](https://github.com/lschyi)
+* Hardware Supported: Phoenix Mechanical Keyboard PCB
+* Hardware Availability: [ErgoKB](https://www.ergokb.tw/products/phoenix/)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make phoenix: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).