summaryrefslogtreecommitdiff
path: root/keyboards/ducky/one2sf/1967st/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/ducky/one2sf/1967st/readme.md')
-rw-r--r--keyboards/ducky/one2sf/1967st/readme.md33
1 files changed, 32 insertions, 1 deletions
diff --git a/keyboards/ducky/one2sf/1967st/readme.md b/keyboards/ducky/one2sf/1967st/readme.md
index 16a932812e..be96a8db71 100644
--- a/keyboards/ducky/one2sf/1967st/readme.md
+++ b/keyboards/ducky/one2sf/1967st/readme.md
@@ -1 +1,32 @@
-# One2SF \ No newline at end of file
+# One 2 SF (DKON1967ST)
+
+A 65% keyboard by Ducky.
+
+This firmware was tested on the Ducky One 2 SF 1967ST version.
+
+* Keyboard Maintainer: [f7urry](https://github.com/f7urry)
+* Hardware Supported: Ducky One 2 SF RGB (DKON1967ST), NUC123SD4AN0 + MBI5043GP
+ * Only ANSI layout is supported at this time (ISO & VIA still WIP).
+ * RGB LEDs are currently disabled until the driver is merged.
+
+## Compiling the Firmware:
+
+ make ducky/one2sf/1967st:default
+
+## Accessing Bootloader Mode
+
+To enter the 1967ST bootloader to flash, boot the keyboard while holding D+L.
+
+## Flashing the Firmware:
+
+There are then two ways to flash the keyboard:
+
+ pip install --user nuvoton-isp
+ nuvoisp -f ducky_one2sf_ansi.bin
+
+Alternatively you can use elfmimi's [nu-isp-cli](https://lib.rs/crates/nu-isp-cli) which is more complete than nuvoisp and allows flashing .hex files as well.
+
+ cargo install nu-isp-cli
+ nu-isp-cli flash ducky_one2sf_ansi.bin
+
+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).