aboutsummaryrefslogtreecommitdiffstats
path: root/keyboards/yurei/readme.md
diff options
context:
space:
mode:
authorGravatar Koichi Katano <36572567+kkatano@users.noreply.github.com>2020-01-14 19:31:21 +0900
committerGravatar James Young <18669334+noroadsleft@users.noreply.github.com>2020-01-14 02:31:21 -0800
commitc58f7857bdeb5b0c4edbf03abefb9d659c2f3cbd (patch)
treeda8e2c4b83bf68e65979260311aa94af325f04c0 /keyboards/yurei/readme.md
parente80fdbf3dc2ed7c2db39b2ac48abd67519fecb02 (diff)
downloadqmk_firmware-c58f7857bdeb5b0c4edbf03abefb9d659c2f3cbd.tar.gz
[Keyboard] Add Yurei PCB (#7880)
* Add yurei * Implement keyboard * Update readme.md * Update config.h * Update info.json * Update info.json * Update keyboards/yurei/config.h * Delete config.h * Update rules.mk * Update yurei.c * Update keymap.c * Update keyboards/yurei/yurei.h * Update keyboards/yurei/keymaps/default/keymap.c * Update keyboards/yurei/info.json * Update keyboards/yurei/rules.mk
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 000000000..fc5b3eb5c
--- /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).