fix: formatting / image links

keyboards/rii/518bt/keyboard.json

@@ -1,45 +1,43 @@
 {
-    "keyboard_name": "518bt",
     "manufacturer": "Rii",
+    "keyboard_name": "518bt",
     "maintainer": "tim-eastwood",
-    "usb": {
-        "vid": "0xFEED",
-        "pid": "0x0011",
-        "device_version": "1.0.0"
-    },
     "backlight": {
-        "pin": "B0",
         "driver": "software",
-        "levels": 7
+        "levels": 7,
+        "pin": "B0"
     },
+    "bootloader": "stm32-dfu",
     "bootmagic": {
         "matrix": [5, 0]
     },
-    "indicators": {
+    "diode_direction": "COL2ROW",
-        "caps_lock": "B1",
-        "on_state": 1
-    },
     "features": {
         "backlight": true,
         "bootmagic": true,
+        "command": true,
         "extrakey": true,
-        "mousekey": false,
+        "nkro": true
-        "nkro": true,
-        "command": true
     },
+    "indicators": {
+        "caps_lock": "B1"
+    },
+    "matrix_pins": {
+        "cols": ["A7", "A6", "A15", "B3", "B4", "B5", "B6", "B7", "B8", "B9", "C13", "C14"],
+        "rows": ["A14", "A1", "A2", "A3", "A4", "A5"]
+    },
+    "processor": "STM32F072",
     "qmk": {
         "locking": {
             "enabled": true,
             "resync": true
         }
     },
-    "matrix_pins": {
+    "usb": {
-        "cols": ["A7", "A6", "A15", "B3", "B4", "B5", "B6", "B7", "B8", "B9", "C13", "C14"],
+        "device_version": "1.0.0",
-        "rows": ["A14", "A1", "A2", "A3", "A4", "A5"]
+        "pid": "0x0011",
+        "vid": "0xFEED"
     },
-    "diode_direction": "COL2ROW",
-    "processor": "STM32F072",
-    "bootloader": "stm32-dfu",
     "layouts": {
         "LAYOUT": {
             "layout": [
@@ -53,7 +51,6 @@
                 {"matrix": [0, 8], "x": 8, "y": 0},
                 {"matrix": [0, 9], "x": 9, "y": 0},
                 {"matrix": [0, 11], "x": 10, "y": 0, "w": 2},
-
                 {"matrix": [1, 0], "x": 0, "y": 1},
                 {"matrix": [1, 1], "x": 1, "y": 1},
                 {"matrix": [1, 2], "x": 2, "y": 1},
@@ -66,7 +63,6 @@
                 {"matrix": [1, 9], "x": 9, "y": 1},
                 {"matrix": [1, 10], "x": 10, "y": 1},
                 {"matrix": [1, 11], "x": 11, "y": 1},
-
                 {"matrix": [2, 0], "x": 0, "y": 2},
                 {"matrix": [2, 1], "x": 1, "y": 2},
                 {"matrix": [2, 2], "x": 2, "y": 2},
@@ -79,7 +75,6 @@
                 {"matrix": [2, 9], "x": 9, "y": 2},
                 {"matrix": [2, 10], "x": 10, "y": 2},
                 {"matrix": [2, 11], "x": 11, "y": 2},
-
                 {"matrix": [3, 0], "x": 0, "y": 3},
                 {"matrix": [3, 1], "x": 1, "y": 3},
                 {"matrix": [3, 2], "x": 2, "y": 3},
@@ -92,7 +87,6 @@
                 {"matrix": [3, 9], "x": 9, "y": 3},
                 {"matrix": [3, 10], "x": 10, "y": 3},
                 {"matrix": [3, 11], "x": 11, "y": 3},
-
                 {"matrix": [4, 0], "x": 0, "y": 4},
                 {"matrix": [4, 1], "x": 1, "y": 4},
                 {"matrix": [4, 2], "x": 2, "y": 4},
@@ -104,7 +98,6 @@
                 {"matrix": [4, 8], "x": 8, "y": 4},
                 {"matrix": [4, 9], "x": 9, "y": 4},
                 {"matrix": [4, 11], "x": 10, "y": 4, "w": 2},
-
                 {"matrix": [5, 0], "x": 0, "y": 5, "w": 2},
                 {"matrix": [5, 1], "x": 2, "y": 5},
                 {"matrix": [5, 2], "x": 3, "y": 5},

keyboards/rii/518bt/keymaps/default/keymap.c

@@ -16,6 +16,16 @@
 #include QMK_KEYBOARD_H
 #define CTALDEL LCTL(LALT(KC_DEL))
 
+void keyboard_pre_init_user(void) {
+  gpio_set_pin_output(B2);
+  gpio_set_pin_output(B10);
+  gpio_set_pin_output(B11);
+  gpio_write_pin_low(B2);
+  gpio_write_pin_low(B10);
+  gpio_write_pin_low(B11);
+}
+
+
 /* Membrane labels - base
  *        .----------------------------------------------------------------------------.
  *        |light | home |  GUI | MUTE | VOL- | VOL+ | Prev | Pause| Next |    Bksp     |

keyboards/rii/518bt/readme.md

@@ -1,42 +1,32 @@
-Rii 518BT (Custom USB PCB)
+# Rii 518BT
-===
 
-This firmware is used with [a custom PCB](https://github.com/tim-eastwood/rii-518bt-usb-qmk-pcb) to replace the original, which is Bluetooth-only, in the Rii 518BT. The drop-in replacement provides a USB2.0 interface, better backlighting, and of course supports QMK.
+![Rii 518BT](https://i.imgur.com/bj3WmLd.png)
 
-![Rii 518BT](https://raw.githubusercontent.com/tim-eastwood/rii-518bt-usb-qmk-pcb/main/pics/1.png)
+*A custom PCB for the Rii 518BT keyboard*
 
-The Rii 518bt is an ultra-compact 68-key keyboard.
+* Keyboard Maintainer: [Tim / Tangles](https://github.com/tim-eastwood)
-
+* Hardware Supported: [Custom USB/STM32F072 PCB for Rii 518bt](https://github.com/tim-eastwood/rii-518bt-usb-qmk-pcb)
-**Keyboard Maintainer:** [Tim / Tangles](https://github.com/tim-eastwood/QMK-rii-518bt-usb)  
+* Hardware Availability: Build it yourself using any PCBA service using the source files / BoM located at [https://github.com/tim-eastwood/rii-518bt-usb-qmk-pcb](https://github.com/tim-eastwood/rii-518bt-usb-qmk-pcb)
-**Hardware Supported:** Rii 518BT with [custom USB/STM32F072 PCB](https://github.com/tim-eastwood/rii-518bt-usb-qmk-pcb)
-**Hardware Availability:** Build it yourself using any PCBA service using the source files / BoM located at [https://github.com/tim-eastwood/rii-518bt-usb-qmk-pcb](https://github.com/tim-eastwood/rii-518bt-usb-qmk-pcb)
 
 Purchasing a Rii 518BT is required to obtain the housing, key membrane, and adhesive sheet of dome switches.
 
----
+Make example for this keyboard (after setting up your build environment):
 
-## Compiling
+    make rii/518bt:default
-
+    or
-In [QMK MSYS](https://docs.qmk.fm/newbs_getting_started#set-up-your-environment), run:
-
-```sh
     qmk compile -kb rii/518bt -km default
-```
 
-## Flashing
+Flashing example for this keyboard:
 
-To compile and flash directly:
+    make rii/518bt:default:flash
-
+    or
-```sh
     qmk flash -kb rii/518bt -km default
-```
 
-## Resources
+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).
 
-- [QMK Build Environment Setup](https://docs.qmk.fm/#/getting_started_build_tools)
+## Bootloader
-- [QMK Make Instructions](https://docs.qmk.fm/#/getting_started_make_guide)
-- [Complete Newbs Guide](https://docs.qmk.fm/#/newbs)
 
----
+Enter the bootloader in 2 ways:
 
-Disclaimer: This is an independent hardware project and is not affiliated with Rii or the original manufacturer.
+* **Bootmagic reset**: Hold down the key at (5,0) in the matrix (Function key) and plug in the keyboard
+* **Physical reset button**: Short the pads on the back of the PCB while plugging in the keyboard