summaryrefslogtreecommitdiffstats
path: root/keyboards/dztech/tofu/ii/readme.md
diff options
context:
space:
mode:
authordztech <moyi4681@users.noreply.github.com>2022-12-13 10:38:15 +0800
committerGitHub <noreply@github.com>2022-12-12 18:38:15 -0800
commit7cf3dd7b8dbbc7ab362f6b3151ac7fffd985a401 (patch)
tree579fdc41b4228645f3e15dff2e91bef3f0ce4458 /keyboards/dztech/tofu/ii/readme.md
parent7578daaf168023ad1dae28e0052d1a508c2c511b (diff)
[Keyboard] add tofu_ii keyboard (#19118)
Co-authored-by: Joel Challis <git@zvecr.com> Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/dztech/tofu/ii/readme.md')
-rw-r--r--keyboards/dztech/tofu/ii/readme.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/keyboards/dztech/tofu/ii/readme.md b/keyboards/dztech/tofu/ii/readme.md
new file mode 100644
index 0000000000..94950987ff
--- /dev/null
+++ b/keyboards/dztech/tofu/ii/readme.md
@@ -0,0 +1,22 @@
+# TOFU_II
+A customizable 66 key RGB keyboard.
+
+* Keyboard Maintainer: [moyi4681](https://github.com/moyi4681)
+* Hardware Supported: TOFU_II
+* Hardware Availability: [KBDfans](https://kbdfans.com/)
+
+## Bootloader mode
+
+Enter the bootloader in 3 ways:
+
+* Bootmagic reset: Hold down the left top key then plug in the USB cable.
+* Physical reset button: Double tap the reset button.
+* Keycode in layout: Press the key mapped to QK_BOOT if it is available.
+
+## Making firmware
+
+Make example for this keyboard (after setting up your build environment):
+
+ make dztech/tofu/ii/v1: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).