summaryrefslogtreecommitdiff
path: root/keyboards/shiro/readme.md
diff options
context:
space:
mode:
authorWilliam Chang <william@factual.com>2019-11-20 22:17:07 -0800
committerWilliam Chang <william@factual.com>2019-11-20 22:17:07 -0800
commite7f4d56592b3975c38af329e77b4efd9108495e8 (patch)
tree0a416bccbf70bfdbdb9ffcdb3bf136b47378c014 /keyboards/shiro/readme.md
parent71493b2f9bbd5f3d18373c518fa14ccafcbf48fc (diff)
parent8416a94ad27b3ff058576f09f35f0704a8b39ff3 (diff)
Merge remote-tracking branch 'upstream/master'
Diffstat (limited to 'keyboards/shiro/readme.md')
-rw-r--r--keyboards/shiro/readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/shiro/readme.md b/keyboards/shiro/readme.md
new file mode 100644
index 0000000000..7c4c024a6b
--- /dev/null
+++ b/keyboards/shiro/readme.md
@@ -0,0 +1,27 @@
+# 素 - Shiro
+
+![Shiro](https://cdn.discordapp.com/attachments/536423734144401422/597447002288291861/P7070070_cp.jpg)
+
+これは日本の名刺(55mmx91mm)に、3x5の15キーを詰め込んだとても小さいキーパッドです。
+
+This product is a 3x5 very small keypad.
+It is made in 55mm x 91mm according to the Japanese business card.
+
+Keyboard Maintainer: [T.Shinohara](https://github.com/ShinoharaTa)
+Hardware Supported: The Shiro PCBs, ProMicro supported. Using only Kailh Low Profile Switches.
+Hardware Availability: [Booth (Japanese Site)](https://shino3.booth.pm/items/1444895)
+日本国内ではBoothで入手できます: [Booth (Japanese Site)](https://shino3.booth.pm/items/1444895)
+
+![Shiro-backside](https://cdn.discordapp.com/attachments/536423734144401422/597464086640328724/20190707_033520.jpg)
+
+Make for this keyboard default keymap (after setting up your build environment):
+
+ make shiro:default
+
+Make for this keyboard build check keymap (after setting up your build environment):
+
+ make shiro:check
+
+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).
+
+[Build guide - Japanese](https://github.com/ShinoharaTa/keyboards/blob/master/Shiro/manual/build_guide_ja.md) \ No newline at end of file