summaryrefslogtreecommitdiff
path: root/keyboards/keycapsss/kimiko/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/keycapsss/kimiko/readme.md')
-rw-r--r--keyboards/keycapsss/kimiko/readme.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/keyboards/keycapsss/kimiko/readme.md b/keyboards/keycapsss/kimiko/readme.md
new file mode 100644
index 0000000000..0e2604079d
--- /dev/null
+++ b/keyboards/keycapsss/kimiko/readme.md
@@ -0,0 +1,23 @@
+# Kimiko
+
+<img src="https://keycapsss.com/media/image/7f/88/2b/kimiko-split-keyboard-1.jpg" width="800" />
+
+A split keyboard with 4x6 vertically staggered keys and thumb keys.
+
+- Per key RGB led's (SK6812 Mini-E)
+- 6 underglow RGB led's per side (SK6812 Mini)
+- Support for 1 rotary encoder per side (two possible positions)
+
+* Keyboard Maintainer: [BenRoe](https://github.com/BenRoe/) [@keycapsss](https://twitter.com/keycapsss)
+* Hardware Supported: Pro Micro 5V/16Mhz and compatible
+* Hardware Availability: [keycapsss.com](https://keycapsss.com)
+
+Make firmware .hex for this keyboard (after setting up your build environment):
+
+ make keycapsss/kimiko:default
+
+Example of flashing this keyboard (or use [QMK Toolbox](https://github.com/qmk/qmk_toolbox)):
+
+ make keycapsss/kimiko: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).