summaryrefslogtreecommitdiffstats
path: root/keyboards/yoichiro/lunakey_mini/readme.md
diff options
context:
space:
mode:
authorYoichiro Tanaka <yoichiro@eisbahn.jp>2020-11-23 06:25:17 +0900
committerGitHub <noreply@github.com>2020-11-22 21:25:17 +0000
commitc84650a147a5bf26322b583be85774121f5464e2 (patch)
treeb9d5965bf4e415ae94f101fb773852c9a90d7fc1 /keyboards/yoichiro/lunakey_mini/readme.md
parent30afa1ccd333a693d7edcda10e618b5c82bc6b98 (diff)
Add a new keyboard: yoichiro/lunakey_mini (#10958)
* Add a new keyboard: yoichiro/lunakey_mini * Modify the VENDOR and PRODUCT IDs. * Remove unnecessary EOL characters. * Remove unnecessary modified characters. * Update the layer definition more simple. * Change the product name. * Change the LAYOUT name (append `_split_3x6_4`) and change keys order in info.json file.
Diffstat (limited to 'keyboards/yoichiro/lunakey_mini/readme.md')
-rw-r--r--keyboards/yoichiro/lunakey_mini/readme.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/keyboards/yoichiro/lunakey_mini/readme.md b/keyboards/yoichiro/lunakey_mini/readme.md
new file mode 100644
index 0000000000..d8579aea89
--- /dev/null
+++ b/keyboards/yoichiro/lunakey_mini/readme.md
@@ -0,0 +1,19 @@
+# Lunakey Mini
+
+![lunakey_mini](https://i.imgur.com/b1oUINil.jpg)
+
+This is a 40% split keyboard which has 3x6 vertically staggered keys and 4 thumbnail keys.
+
+* Keyboard Maintainer: [Yoichiro Tanaka](https://github.com/yoichiro)
+* Hardware Supported: Lunakey Mini PCB, Pro Micro MCU.
+* Hardware Availability: https://yoichiro.booth.pm/
+
+Make example for this keyboard (after setting up your build environment):
+
+ make yoichiro/lunakey_mini:default
+
+Flashing example for this keyboard:
+
+ make yoichiro/lunakey_mini: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).