README.md

QMK Firmware

The QMK firmware powers my keyboards. This is the source code for my keyboard layouts.

.
├── LICENSE.txt
├── README.md
├── Rakefile      # Tasks for managing QMK source
├── combos.yaml   # Combo definitions (COMBO_ENABLE)
├── ...
├── planck        # Keyboard/keymap-specific files
│   ├── README.md
│   ├── keymap.c  # Keymap implementation
│   └── rules.mk  # Keymap make rules
├── ...
├── qmk           # QMK firmware source tree
│   └── ...
└── user          # Keyboard/keymap-agnostic files
    ├── config.h  # Configuration applied across all keymaps
    ├── my.c      # Global implementation file
    ├── my.h      # Global header file
    ├── ...
    └── rules.mk  # Global make rules

Building

The Rakefile manages the QMK firmware source code:

rake ci           # Build all keymaps for CI
rake clean        # Remove build artifacts
rake generate     # Regenerate generated C files
rake install      # Symlink keymap files into QMK source tree
rake qmk:install  # Install QMK dependencies
rake qmk:update   # Update QMK firmware
rake uninstall    # Remove symlinks from QMK source tree