QMK (Quantum Mechanical Keyboard) 是一个开源社区,维护 QMK 固件,QMK 工具箱,qmk.fm,和这些文档。QMK 是基于 tmk_keyboard 的一个键盘固件,具有 Atmel AVR 控制器的一些有用功能,更具体地说,是 OLKB 产品系列,ErgoDox EZ 键盘和 Clueboard 产品系列。
OLKB 产品线,ErgoDox EZ键盘,ErgoDox EZ 键盘,Clueboard 产品线,它也被使用 ChibiOS 移植到 ARM 芯片上,你可以使用它驱动你自定义的键盘或者 PCB。
你如果打算向 QMK 提供按键映射,键盘或功能,最简单的方法是通过 Github fork 这个仓库,并且克隆仓库到本地进行更改,推送它们,然后从你 fork 的仓库 Pull Request 。
或者,你可以直接下载 (zip、tar),或通过 git(git@github.com:qmk/qmk_firmware.git)、https (https://github.com/qmk/qmk_firmware.git) 克隆它。
在你能够编译之前,你需要为 AVR 或 ARM 安装一个开发环境。一旦完成,你就可以使用 make
命令编译了。例如:
make planck/rev4:default
这将使用默认的按键映射构建 planck
的 rev4
修订版。并非所有键盘都有修订版(也称为子项目或文件夹),在这种情况下,它可以省略:
make preonic:default