92a787ca4c
|
||
|---|---|---|
| .. | ||
| README.md | ||
| _summary.md | ||
| getting_started_build_tools.md | ||
| getting_started_getting_help.md | ||
| getting_started_github.md | ||
| getting_started_introduction.md | ||
| newbs.md | ||
| newbs_getting_started.md | ||
README.md
Quantum Mechanical Keyboard Firmware
Что такое QMK Firmware?
QMK (Quantum Mechanical Keyboard) — это сообщество, работающее над ПО с открытым исходным кодом, которое разрабатывает QMK Firmware, QMK Toolbox, qmk.fm и эту документацию. QMK Firmware — это прошивка для клавиатур, основанная на tmk_keyboard с множеством полезных функций для микроконтроллеров Atmel AVR, а именно, для продуктов компаний OLKB, ErgoDox EZ и Clueboard. Она также была портирована на чипы ARM при помощи ChibiOS. Вы можете использовать ее для клавиатуры, собранной вручную или имеющей нестандартную печатную плату.
Как скачать
Если вы собираетесь добавить раскладку, клавиатуру или новые функции в QMK, то самый простой путь реализации — это сделать форк репозитория на GitHub, клонировать ваш репозиторий локально для дальнейшего внесения изменений, сделать пуш изменений, а затем открыть пулреквест из вашего форка.
Также вы можете либо скачать репозиторий (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
Данная команда соберет ревизию rev4 клавиатуры planck с раскладкой default. Не все клавиатуры имеют ревизии (они также называются subprojects или folders), в этом случае она может быть опущена:
make preonic:default
Как настроить
QMK обладает множеством функций для исследования, и справочная документация может стать хорошей отправной точкой для знакомства с ними. Большинством функций можно воспользоваться модифицируя раскладку и изменяя коды клавиш.