qmk_firmware README

The project's README from github.com/qmk/qmk_firmware. As one markdown file: README.md.

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 VitePress. 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.

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.

qmk_firmware (qmk/qmk_firmware)

Searching Database…

这是什么?QMK 是一个基于 tmk_keyboard 的开源键盘固件,为 Atmel AVR 和 ARM 控制器增加了许多功能。它最广为人知的是 OLKB 产品线以及 ErgoDox EZ 和 Clueboard 键盘。
它是运行在键盘本身上,还是运行在我的电脑上?运行在键盘本身上——QMK 是固件,存放在键盘的 Atmel AVR 或 ARM 控制器里。你的电脑只会把它当成一个普通的 USB 键盘。
我怎么把它刷到键盘上?README 指向 docs.qmk.fm 上的官方文档——安装、编译和刷写的说明都在那里。
编译它需要我的电脑上装些什么?固件本身是用 C 语言为 AVR 和 ARM 芯片编写的,仓库里还附带了基于 Python 的配套工具。
它开箱支持哪些键盘?OLKB 的 Planck 和 Preonic、ErgoDox EZ、Clueboard 的各款键盘以及 Cluepad 数字小键盘,还有 Atreus——除此之外,许多其他键盘也有社区支持。
我可以离线阅读文档吗?可以——docs.qmk.fm 上的文档由 VitePress 驱动,支持离线查看;README 里指向了一个介绍如何离线预览的页面。
QMK 是什么的缩写?Quantum Mechanical Keyboard(量子机械键盘)。它在 Hasu 的 tmk_keyboard 固件基础上扩展而来,由 OLKB 的 Jack Humbert 开发和维护,并有社区的贡献。
我该怎么查我自己的键盘型号是否受支持?官方网站 qmk.fm 上有 QMK 支持的全部键盘列表的链接,和文档以及这个仓库放在一起。
官方机型之外的键盘也能运行 QMK 吗?可以——除了官方支持的机型之外,这个项目对许多其他键盘也有社区支持;要修改或添加支持,只需 fork 这个仓库并提交 pull request。
Creator
qmk
Size
528.4 MB
Stars
20.8K
Updated
CommitOct 16
Age
11y
Commits · 90 Days