summaryrefslogtreecommitdiff
path: root/keyboards/yurei/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/yurei/readme.md')
-rw-r--r--keyboards/yurei/readme.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/keyboards/yurei/readme.md b/keyboards/yurei/readme.md
new file mode 100644
index 0000000000..fc5b3eb5c0
--- /dev/null
+++ b/keyboards/yurei/readme.md
@@ -0,0 +1,13 @@
+# Yurei
+
+A Tenkeyless PCB inspired by Phantom, for customizing Filco Majestouch 2.
+
+* Keyboard Maintainer: [Koichi Katano](https://github.com/kkatano)
+* Hardware Supported: Yurei PCB
+* Hardware Availability: https://github.com/kkatano/yurei
+
+Make example for this keyboard (after setting up your build environment):
+
+ make yurei: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).