/qmk_firmware-fork

Fork of CRImier/qmk_firmware for modding the Framework keyboard controller

Primary LanguageCGNU General Public License v2.0GPL-2.0

Notes to self for this modified version

  • Install qmk CLI tool: python3 -m pip install --user qmk
  • Set up IDE support: qmk generate-compilation-database -kb framework_rp2040_controller -km default
  • Build: qmk compile -kb framework_rp2040_controller -km default
  • Flash: qmk flash -kb framework_rp2040_controller -km default
    • Press Fn+Right Shift, or plug in again holding C, then mount the drive that pops up.
  • Debugging:
    • https://bbs.archlinux.org/viewtopic.php?id=278341 except use this line: KERNEL=="hidraw*", SUBSYSTEM=="hidraw", MODE="0660", GROUP="input", TAG+="uaccess", TAG+="udev-acl" (not sure yet what the tags do)
    • in info.json, set "console": true
    • in keymap.c, in keyboard_post_init_user, do debug_enable=true;
    • #include "print.h" and print with either print or uprintf
    • qmk console before flashing

Original readme follows:

Quantum Mechanical Keyboard Firmware

Current Version Discord Docs Status GitHub contributors GitHub forks

This is a keyboard firmware based on the tmk_keyboard firmware with some useful features for Atmel AVR and ARM controllers, and more specifically, the OLKB product line, the ErgoDox EZ keyboard, and the Clueboard product line.

Documentation

The docs are powered by Docsify and hosted on GitHub. They are also viewable offline; see Previewing the Documentation for more details.

You can request changes by making a fork and opening a pull request, or by clicking the "Edit this page" link at the bottom of any page.

Supported Keyboards

The project also includes community support for lots of other keyboards.

Maintainers

QMK is developed and maintained by Jack Humbert of OLKB with contributions from the community, and of course, Hasu. The OLKB product firmwares are maintained by Jack Humbert, the Ergodox EZ by ZSA Technology Labs, the Clueboard by Zach White, and the Atreus by Phil Hagelberg.

Official Website

qmk.fm is the official website of QMK, where you can find links to this page, the documentation, and the keyboards supported by QMK.