summaryrefslogtreecommitdiff
path: root/keyboards/dztech/tofu/jr/v1/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/dztech/tofu/jr/v1/readme.md')
-rw-r--r--keyboards/dztech/tofu/jr/v1/readme.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/keyboards/dztech/tofu/jr/v1/readme.md b/keyboards/dztech/tofu/jr/v1/readme.md
new file mode 100644
index 0000000000..f17b9aea90
--- /dev/null
+++ b/keyboards/dztech/tofu/jr/v1/readme.md
@@ -0,0 +1,22 @@
+# TOFU_JR_V1
+A customizable 65% RGB keyboard.
+
+* Keyboard Maintainer: [moyi4681](https://github.com/moyi4681)
+* Hardware Supported: TOFU_JR_V1
+* 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/jr: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).