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 — это open-source прошивка для клавиатур, основанная на tmk_keyboard, с дополнительными возможностями для контроллеров Atmel AVR и ARM. Больше всего она известна по линейке продуктов OLKB, клавиатурам ErgoDox EZ и Clueboard.
Это работает на самой клавиатуре или на моём компьютере?На самой клавиатуре — QMK это прошивка, которая живёт на контроллере Atmel AVR или ARM внутри платы. Компьютер просто видит обычную USB-клавиатуру.
Как установить её на свою клавиатуру?README отсылает к официальной документации на docs.qmk.fm — инструкции по настройке, сборке и прошивке находятся там.
Что нужно на компьютере, чтобы её собрать?Сама прошивка написана на C для чипов AVR и ARM, а в репозитории также есть инструменты на Python для работы с ней.
Какие клавиатуры она поддерживает из коробки?Planck и Preonic от OLKB, ErgoDox EZ, платы Clueboard и Cluepad, а также Atreus — плюс поддержка со стороны сообщества для множества других плат.
Можно ли читать документацию офлайн?Да — документация на docs.qmk.fm работает на VitePress и доступна офлайн; в README есть ссылка на страницу о том, как её открыть локально.
Как расшифровывается QMK?Quantum Mechanical Keyboard. Проект расширяет прошивку tmk_keyboard от Hasu, а разрабатывает и поддерживает его Джек Хамберт (Jack Humbert) из OLKB вместе с вкладом сообщества.
Как узнать, поддерживается ли моя модель клавиатуры?Официальный сайт qmk.fm вместе с документацией и этим репозиторием даёт ссылку на полный список клавиатур, поддерживаемых QMK.
Могут ли неофициальные платы работать на QMK?Да — помимо официальной линейки проект поддерживает множество других клавиатур силами сообщества, а изменения и дополнения вносятся через форк репозитория и pull request.
Creator
qmk
Size
528.4 MB
Stars
20.8K
Updated
CommitOct 16
Age
11y
Commits · 90 Days