This repository has been archived on 2025-01-28. You can view files and clone it, but cannot push or open issues or pull requests.
James Young fced377ac0
2020 May 30 Breaking Changes Update ()
* Branch point for 2020 May 30 Breaking Change

* Migrate `ACTION_LAYER_TOGGLE` to `TG()` ()

* Migrate `ACTION_MODS_ONESHOT` to `OSM()` ()

* Migrate `ACTION_DEFAULT_LAYER_SET` to `DF()` ()

* Migrate `ACTION_LAYER_MODS` to `LM()` ()

* Migrate `ACTION_MODS_TAP_KEY` to `MT()` ()

* Convert V-USB usbdrv to a submodule ()

* Unify Tap Hold functions and documentation ()

* Changing board names to prevent confusion ()

* Move the Keyboardio Model01 to a keyboardio/ subdir ()

* Move spaceman keyboards ()

* Migrate miscellaneous `fn_actions` entries ()

* Migrate `ACTION_MODS_KEY` to chained mod keycodes ()

* Organizing my keyboards (plaid, tartan, ergoinu) ()

* Refactor Lily58 to use split_common ()

* Refactor zinc to use split_common ()

* Add a message if bin/qmk doesn't work ()

* Fix conflicting types for 'tfp_printf' ()

* Fixed RGB_DISABLE_AFTER_TIMEOUT to be seconds based & small internals cleanup ()

* Refactor and updates to TKC1800 code ()

* Switch to qmk forks for everything ()

* audio refactor: replace deprecated PLAY_NOTE_ARRAY ()

* Audio enable corrections (2/3) ()

* Split HHKB to ANSI and JP layouts and Add VIA support for each ()

* Audio enable corrections (Part 4) ()

* Fix typo from PR7114 ()

* Augment future branch Changelogs ()

* Revert "Branch point for 2020 May 30 Breaking Change"
2020-05-30 13:14:59 -07:00
..
2019-12-11 11:36:00 -08:00

QMK机械键盘固件

当前版本 开发状态 异议 文档状态 GitHub贡献者 GitHub分支

什么是 QMK 固件?

QMK (Quantum Mechanical Keyboard) 是一个社区维护的开源软件,包括 QMK 固件, QMK 工具箱, qmk.fm网站, 和这些文档。QMK 固件是一个基于tmk_keyboard的键盘固件它在爱特梅尔AVR微控制器实现一些有用的功能,确切地说, 是在 OLKB product line, 在 ErgoDox EZ 键盘, 和 Clueboard product line. 上。它被移植到使用ChibiOS的ARM芯片上. 它可以在飞线键盘或定制PCB键盘中发挥功能.

如何得到它

如果你打算贡献布局, 键盘, 或者其他QMK特性, 一下是最简单的方法:从GitHub获得repo分支, 并克隆你的repo到本地进行编辑推送然后从你的分支打开 Pull Request.

此外, 你也可以直接下载 (zip, tar), 或者从git克隆 (git@github.com:qmk/qmk_firmware.git), 或 https (https://github.com/qmk/qmk_firmware.git).

如何编译

在你能编译之前, 你需要部署环境 用于 AVR or/and ARM 开发。完成后, 你可以使用 make 命令来编译一个键盘和布局使用以下命令:

make planck/rev4:default

这将建立 planckrev4 修订版本并使用 default布局。并非所有键盘都有修订版本 (也叫做子项目或文件夹),在此情况下,修订版本可以省略,如下:

make preonic:default

如何定制

QMK 有许多 特性来探索,也有很多 参考文档 供您发掘。你可以通过修改 布局键码来利用许多特性。