Ducky One 2 SF touch-up (qmk#17672)

* info.json: correct JSON syntax error * info.json: correct key sizes * update readme files Moves nearly all of the information about this keyboard to the 1967st version's readme, because this readme is exposed in QMK Configurator. Also updates the readme to align more closely with QMK's keyboard readme template. * info.json: update metadata Updates the keyboard name and maintainer fields.
mvzink · Jul 13, 2022 · 4ef0c82 · 4ef0c82
1 parent f7510ca
commit 4ef0c82
Show file tree

Hide file tree

Showing 3 changed files with 45 additions and 30 deletions.
diff --git a/keyboards/ducky/one2sf/1967st/info.json b/keyboards/ducky/one2sf/1967st/info.json
@@ -1,5 +1,6 @@
 {
-    "keyboard_name": "Ducky One 2 SF",
+    "keyboard_name": "Ducky One 2 SF (DKON1967ST)",
+    "maintainer": "f7urry",
     "layouts": {
         "LAYOUT_all": {
             "layout": [
@@ -17,7 +18,7 @@
                 { "x": 11, "y": 0, "w": 1, "label": "DASH" },
                 { "x": 12, "y": 0, "w": 1, "label": "EQUALSIGN" },
                 { "x": 13, "y": 0, "w": 2, "label": "BACKSPACE" },
-                { "x": 15.25, "y": 0, "w": 2, "label": "DEL" },
+                { "x": 15.25, "y": 0, "w": 1, "label": "DEL" },
 
                 { "x": 0, "y": 1, "w": 1.5, "label": "TAB" },
                 { "x": 1.5, "y": 1, "w": 1, "label": "Q" },
@@ -33,7 +34,7 @@
                 { "x": 11.5, "y": 1, "w": 1, "label": "LBRACKET" },
                 { "x": 12.5, "y": 1, "w": 1, "label": "RBRACKET" },
                 { "x": 13.5, "y": 1, "w": 1.5, "label": "BACKSLASH" },
-                { "x": 15.25, "y": 1, "w": 1.5, "label": "PAGEUP" },
+                { "x": 15.25, "y": 1, "w": 1, "label": "PAGEUP" },
 
                 { "x": 0, "y": 2, "w": 1.75, "label": "CAPSLOCK" },
                 { "x": 1.75, "y": 2, "w": 1, "label": "A" },
@@ -49,7 +50,7 @@
                 { "x": 11.75, "y": 2, "w": 1, "label": "QUOTE" },
                 { "x": 12.75, "y": 2, "w": 1, "label": "ISOHASH" },
                 { "x": 13.75, "y": 2, "w": 1.25, "label": "ENTER" },
-                { "x": 15.25, "y": 2, "w": 1.25, "label": "PAGEDOWN" },
+                { "x": 15.25, "y": 2, "w": 1, "label": "PAGEDOWN" },
 
                 { "x": 0, "y": 3, "w": 1.25, "label": "LSHIFT" },
                 { "x": 1.25, "y": 3, "w": 1, "label": "ISOBACKSLASH" },
@@ -63,8 +64,8 @@
                 { "x": 9.25, "y": 3, "w": 1, "label": "COMMA" },
                 { "x": 10.25, "y": 3, "w": 1, "label": "PERIOD" },
                 { "x": 11.25, "y": 3, "w": 1, "label": "SLASH" },
-                { "x": 12.25, "y": 3, "w": 2.75, "label": "RSHIFT" },
-                { "x": 14.25, "y": 3, "w": 2.75, "label": "UP" },
+                { "x": 12.25, "y": 3, "w": 2, "label": "RSHIFT" },
+                { "x": 14.25, "y": 3, "w": 1, "label": "UP" },
 
                 { "x": 0, "y": 4, "w": 1.25, "label": "LCTRL" },
                 { "x": 1.25, "y": 4, "w": 1.25, "label": "LCMD" },
@@ -74,7 +75,7 @@
                 { "x": 11, "y": 4, "w": 1, "label": "FN" },
                 { "x": 12, "y": 4, "w": 1.25, "label": "RCTRL" },
                 { "x": 13.25, "y": 4, "w": 1, "label": "LEFT" },
-                { "x": 14.25, "y": 4, "w": 1, "label": "DOWN" }
+                { "x": 14.25, "y": 4, "w": 1, "label": "DOWN" },
                 { "x": 15.25, "y": 4, "w": 1, "label": "RIGHT" }
             ]
         }

diff --git a/keyboards/ducky/one2sf/1967st/readme.md b/keyboards/ducky/one2sf/1967st/readme.md
@@ -1 +1,32 @@
-# One2SF
+# 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).
diff --git a/keyboards/ducky/one2sf/readme.md b/keyboards/ducky/one2sf/readme.md
@@ -1,25 +1,8 @@
-# One2SF
+# One 2 SF
 
-A 65% keyboard by Ducky
+A 65% keyboard by Ducky.
 
-* Hardware Supported: Ducky One 2 SF RGB / NUC123SD4AN0 / MBI5043GP
-* Layout only support for ANSI (ISO & VIA still WIP)
-Make example for this keyboard (after setting up your build environment):
+The only supported keyboard version at this time is the DKON1967ST.
 
-    make ducky/one2sf: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).
-
-RGB LEDs are currently disabled until the driver is merged.
-
-This firmware was tested on the duckyon2sf 1967ST version. To enter the 1967ST bootloader to flash you can boot the keyboard while holding D+L.
-
-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
+* Hardware Supported:
+  * [DKON1967ST](1967st/), NUC123SD4AN0 + MBI5043GP