summaryrefslogtreecommitdiff
path: root/keyboards/kuro/kuro65/readme.md
diff options
context:
space:
mode:
authorTobias Minn <tobias.minn@gmail.com>2023-03-21 06:30:21 +0100
committerGitHub <noreply@github.com>2023-03-20 22:30:21 -0700
commitf55d2cd6b66106621253c9d5d7f6d14824774ef5 (patch)
treee795c3ea4e5b8c15c1dde5c86f99b4123b1d6311 /keyboards/kuro/kuro65/readme.md
parent63af5cd50e8914a777fdce637c164238d023b19c (diff)
[Keyboard] Add Kuro65 keyboard (#20122)
Co-authored-by: jack <0x6a73@protonmail.com> Co-authored-by: Less/Rikki <86894501+lesshonor@users.noreply.github.com>
Diffstat (limited to 'keyboards/kuro/kuro65/readme.md')
-rw-r--r--keyboards/kuro/kuro65/readme.md41
1 files changed, 41 insertions, 0 deletions
diff --git a/keyboards/kuro/kuro65/readme.md b/keyboards/kuro/kuro65/readme.md
new file mode 100644
index 0000000000..6c57c45a42
--- /dev/null
+++ b/keyboards/kuro/kuro65/readme.md
@@ -0,0 +1,41 @@
+# Kuro 65
+A 65% keyboard with an ISO layout, which fits the TOFU65 case (and similar) by KBDFans.
+
+Keyboard maintainer: [0x544D](https://github.com/0x544D)
+
+Hardware availability: [0x544D/kuro65](https://github.com/0x544D/kuro65)
+
+## Features
+
+- Hot-swappable ISO layout
+- Per key RGB LED (south facing)
+- VIA compatible
+- USB-C connector
+- Reset button on the back of the PCB
+- Compatible with TOFU65 and similar cases
+
+## Pictures
+
+![kuro65_pcb](https://i.imgur.com/m5KoeQwh.jpg)
+
+![kuro65_case](https://i.imgur.com/jmoACMSh.jpg)
+
+## Building the firmware
+
+Make example for this keyboard (after setting up your build environment):
+
+ make kuro/kuro65:default
+
+Flashing example for this keyboard:
+
+ make kuro/kuro65: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).
+
+## Bootloader
+
+Enter the bootloader in 3 ways:
+
+* **Bootmagic reset**: Hold down the top-left key (ESC) and plug in the keyboard.
+* **Physical reset button**: Briefly press the button on the back of the PCB.
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available. In the pre-supplied keymaps it is on the Function 2 (FN2) layer, replacing the P key.