qmk_firmware

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

readme.md (4523B)


      1 # DecenTKL
      2 
      3 *A TKL keyboard inspired by the language design of Atari XE and ST computers*
      4 
      5 * Keyboard Maintainer: [Bertrand Le roy](https://github.com/bleroy/3d-junkyard/blob/main/DecenTKL/)
      6 * Hardware Supported: DecenTKL (Pi Pico based)
      7 * Hardware Availability: Custom built but open-source
      8 
      9 Make example for this keyboard (after setting up your build environment):
     10 
     11     make decent/tkl:default
     12 
     13 Flashing example for this keyboard:
     14 
     15     make decent/tkl:default:flash
     16 
     17 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).
     18 
     19 ## Bootloader
     20 
     21 Press the escape key or the button on the back of the Pi while connecting the keyboard.
     22 
     23 ## Special commands
     24 
     25 Fn + F1: Open my computer
     26 Fn + F2: Browser home
     27 Fn + F3: Open calculator
     28 Fn + F4: Open media player
     29 Fn + F5: Previous media
     30 Fn + F6: Next media
     31 Fn + F7: Play media
     32 Fn + F8: Stop media
     33 Fn + F9: Mute
     34 Fn + PgUp: Volume up
     35 Fn + PgDn: Volume down
     36 Fn + 1: Toggle RGB lighting
     37 Fn + Up: Next RGB effect
     38 Fn + Down: Previous RGB effect
     39 Fn + X: Change RGB hue
     40 Fn + S: Lower RGB brightness
     41 Fn + W: Raise RGB brightness
     42 Fn + Left: Lower RGB animation speed
     43 Fn + Right: Raise RGB animation speed
     44 
     45 Fn + \: go into bootloader mode without unplugging the keyboard
     46 
     47 ## Layout
     48 ```C
     49 /*
     50     *   /─────/       /─────/─────/─────/─────/─────/─────/─────/─────/─────/─────/
     51     *  /Esc  /       /F1   /F2   /F3   /F4   /F5   /F6   /F7   /F8   /F9   /F10  /
     52     * /─────/       /─────/─────/─────/─────/─────/─────/─────/─────/─────/─────/
     53     * ┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───────┐ ┌───┬───┬───┐
     54     * │ ` │ 1 │ 2 │ 3 │ 4 │ 5 │ 6 │ 7 │ 8 │ 9 │ 0 │ - │ = │ Backsp│ │Ins│Hom│PgU│
     55     * ├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─────┤ ├───┼───┼───┤
     56     * │ Tab │ Q │ W │ E │ R │ T │ Y │ U │ I │ O │ P │ [ │ ] │  \  │ │Del│End│PgD│
     57     * ├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴─────┤ └───┴───┴───┘
     58     * │ Caps │ A │ S │ D │ F │ G │ H │ J │ K │ L │ ; │ ' │  Enter │
     59     * ├──────┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴────────┤     ┌───┐
     60     * │ Shift  │ Z │ X │ C │ V │ B │ N │ M │ , │ . │ / │    Shift │     │ ↑ │
     61     * ├────┬───┴┬──┴─┬─┴───┴───┴───┴───┴───┴──┬┴───┼───┴┬────┬────┤ ┌───┼───┼───┐
     62     * │Ctrl│GUI │Alt │                        │ Alt│ Fn │Menu│Ctrl│ │ ← │ ↓ │ → │
     63     * └────┴────┴────┴────────────────────────┴────┴────┴────┴────┘ └───┴───┴───┘
     64 */
     65 ```
     66 
     67 When holding Fn down:
     68 
     69 ```C
     70 /*
     71     *  /     /       /MyCmp/HomeP/Calc /Media/ ⏮  / ⏭  / ⏯   / ⏹   /Mute /     /
     72     *
     73     * │   │💡│   │   │   │   │   │   │   │   │   │   │   │       │ │   │   │V+ │
     74     * │     │   │🔆│   │   │   │   │   │   │   │   │   │   │BootL│ │   │   │V- │
     75     * │      │   │🔅│   │   │   │   │   │   │   │   │   │        │
     76     * │        │   │🎨│   │   │   │   │   │   │   │   │          │     │🗘 │
     77     * │    │    │    │                        │    │    │    │    │ │㉈ │🗘 │㉏ │
     78 */
     79 ```