qmk_firmware

QMK firmware for my keyboards (Corne, Sweep Ferris) and trackball (Ploopy Adept)
Log | Files | Refs | Submodules | LICENSE

readme.md (2715B)

      1 # DecenTKL NumPad
      2 
      3 *A numeric pad to go with the DecenTKL keyboard*
      4 
      5 This numeric pad also includes a 3-port USB hub, enabling the connection of the TKL
      6 keyboard on the back of the pad.
      7 
      8 The pad also has two Atari joystick ports.
      9 
     10 * Keyboard Maintainer: [Bertrand Le roy](https://github.com/bleroy/3d-junkyard/blob/main/DecenTKL/)
     11 * Hardware Supported: DecenTKL (RP2040-based)
     12 * Hardware Availability: Custom built but open-source
     13 
     14 Make example for this keyboard (after setting up your build environment):
     15 
     16     make decent/numpad:default
     17 
     18 Flashing example for this keyboard:
     19 
     20     make decent/numpad:default:flash
     21 
     22 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).
     23 
     24 ## Bootloader
     25 
     26 Press the Num key or the button on the back of the board while connecting the pad.
     27 
     28 ## Special commands
     29 
     30 Num + Enter: go into bootloader mode without unplugging the keyboard
     31 
     32 ## Layout
     33 ```C
     34 /*
     35  *    /─────/─────/
     36  *   /F11  /F12  /
     37  *  /─────/─────/
     38  * ┌───┬───┬───┬───┐
     39  * │Num│ / │ * │ - │
     40  * ├───┼───┼───┼───┤
     41  * │ 7 │ 8 │ 9 │ + │
     42  * ├───┼───┼───┤   │
     43  * │ 4 │ 5 │ 6 │   │
     44  * ├───┼───┼───┼───┤
     45  * │ 1 │ 2 │ 3 │Ent│
     46  * ├───┴───┼───┤ er│
     47  * │ 0     │ . │   │
     48  * └───────┴───┴───┘
     49  */
     50 ```
     51 
     52 While holding the Num key:
     53 
     54 ```C
     55 /*
     56  *            /─────────/─────────/
     57  *           /Shift+F11/Shift+F12/
     58  *          /─────────/─────────/
     59  * ┌───────┬───────┬───────┬───────┐
     60  * │       │       │       │Bright-│
     61  * ├───────┼───────┼───────┼───────┤
     62  * │       │ Hue + │       │Bright+│
     63  * ├───────┼───────┼───────┤       │
     64  * │Speed -│ Swirl │Speed +│       │
     65  * ├───────┼───────┼───────┼───────┤
     66  * │Mode - │ Hue - │Mode + │       │
     67  * ├───────┴───────┼───────┤BootSel│
     68  * │ on / off      │       │       │
     69  * └───────────────┴───────┴───────┘
     70  */
     71 ```