33 lines
4.0 KiB
Markdown
33 lines
4.0 KiB
Markdown
|
# Quantum Mechanical Keyboard Firmware
|
|||
|
|
|
|||
|
|
[](https://github.com/qmk/qmk_firmware/tags)
|
|||
|
|
[](https://travis-ci.org/qmk/qmk_firmware)
|
|||
|
|
[](https://discord.gg/Uq7gcHh)
|
|||
|
|
[](https://docs.qmk.fm)
|
|||
|
|
[](https://github.com/qmk/qmk_firmware/pulse/monthly)
|
|||
|
|
[](https://github.com/qmk/qmk_firmware/)
|
|||
|
|
|
|||
|
|
## Что такое QMK Firmware?
|
|||
|
|
|
|||
|
|
QMK (*Quantum Mechanical Keyboard*) — это сообщество, работающее над ПО с открытым исходным кодом, которое разрабатывает QMK Firmware, QMK Toolbox, qmk.fm и эту документацию. QMK Firmware — это прошивка для клавиатур, основанная на [tmk\_keyboard](http://github.com/tmk/tmk_keyboard) с множеством полезных функций для микроконтроллеров Atmel AVR, а именно, для продуктов компаний [OLKB](http://olkb.com), [ErgoDox EZ](http://www.ergodox-ez.com) и [Clueboard](http://clueboard.co/). Она также была портирована на чипы ARM при помощи ChibiOS. Вы можете использовать ее для клавиатуры, собранной вручную или имеющей нестандартную печатную плату.
|
|||
|
|
|
|||
|
|
## Как скачать
|
|||
|
|
|
|||
|
|
Если вы собираетесь добавить раскладку, клавиатуру или новые функции в QMK, то самый простой путь реализации — это [сделать форк репозитория на GitHub](https://github.com/qmk/qmk_firmware#fork-destination-box), клонировать ваш репозиторий локально для дальнейшего внесения изменений, сделать пуш изменений, а затем открыть [пулреквест](https://github.com/qmk/qmk_firmware/pulls) из вашего форка.
|
|||
|
|
|
|||
|
|
Также вы можете либо скачать репозиторий ([zip](https://github.com/qmk/qmk_firmware/zipball/master), [tar](https://github.com/qmk/qmk_firmware/tarball/master)), либо клонировать его через git (`git@github.com:qmk/qmk_firmware.git`) или https (`https://github.com/qmk/qmk_firmware.git`).
|
|||
|
|
|
|||
|
|
## Как скомпилировать
|
|||
|
|
|
|||
|
|
Перед компиляцией вам необходимо [настроить окружение](ru-ru/getting_started_build_tools.md) разработчика для AVR или/и ARM. После этого используйте команду `make` со следующим синтаксисом, чтобы собрать клавиатуру и раскладку:
|
|||
|
|
|
|||
|
|
make planck/rev4:default
|
|||
|
|
|
|||
|
|
Данная команда соберет ревизию `rev4` клавиатуры `planck` с раскладкой `default`. Не все клавиатуры имеют ревизии (они также называются subprojects или folders), в этом случае она может быть опущена:
|
|||
|
|
|
|||
|
|
make preonic:default
|
|||
|
|
|
|||
|
|
## Как настроить
|
|||
|
|
|
|||
|
|
QMK обладает множеством [функций](ru-ru/features.md) для исследования, и [справочная документация](http://docs.qmk.fm) может стать хорошей отправной точкой для знакомства с ними. Большинством функций можно воспользоваться модифицируя [раскладку](ru-ru/keymap.md) и изменяя [коды клавиш](ru-ru/keycodes.md).
|