keychron_qmk_firmware/docs/zh-cn
2022-04-27 18:19:56 +08:00
..
_summary.md
api_docs.md Add playground branch 2022-04-27 18:19:56 +08:00
api_overview.md Add playground branch 2022-04-27 18:19:56 +08:00
cli_commands.md Add playground branch 2022-04-27 18:19:56 +08:00
cli_configuration.md Add playground branch 2022-04-27 18:19:56 +08:00
cli_tab_complete.md Add playground branch 2022-04-27 18:19:56 +08:00
cli.md Add playground branch 2022-04-27 18:19:56 +08:00
configurator_architecture.md Add playground branch 2022-04-27 18:19:56 +08:00
configurator_default_keymaps.md Add playground branch 2022-04-27 18:19:56 +08:00
configurator_step_by_step.md Add playground branch 2022-04-27 18:19:56 +08:00
configurator_troubleshooting.md Add playground branch 2022-04-27 18:19:56 +08:00
contributing.md
custom_quantum_functions.md
driver_installation_zadig.md Add playground branch 2022-04-27 18:19:56 +08:00
easy_maker.md Add playground branch 2022-04-27 18:19:56 +08:00
faq_build.md
faq_debug.md
faq_general.md
faq_keymap.md
faq_misc.md Add playground branch 2022-04-27 18:19:56 +08:00
faq.md
feature_grave_esc.md Add playground branch 2022-04-27 18:19:56 +08:00
feature_space_cadet.md Add playground branch 2022-04-27 18:19:56 +08:00
flashing_bootloadhid.md Add playground branch 2022-04-27 18:19:56 +08:00
flashing.md Add playground branch 2022-04-27 18:19:56 +08:00
getting_started_docker.md Add playground branch 2022-04-27 18:19:56 +08:00
getting_started_getting_help.md
getting_started_github.md
getting_started_introduction.md
getting_started_vagrant.md Add playground branch 2022-04-27 18:19:56 +08:00
hand_wire.md Add playground branch 2022-04-27 18:19:56 +08:00
keymap.md Add playground branch 2022-04-27 18:19:56 +08:00
mod_tap.md Add playground branch 2022-04-27 18:19:56 +08:00
newbs_best_practices.md
newbs_building_firmware_configurator.md Add playground branch 2022-04-27 18:19:56 +08:00
newbs_building_firmware.md
newbs_flashing.md
newbs_getting_started.md
newbs_learn_more_resources.md
newbs_testing_debugging.md
newbs.md
other_eclipse.md Add playground branch 2022-04-27 18:19:56 +08:00
other_vscode.md Add playground branch 2022-04-27 18:19:56 +08:00
README.md
reference_configurator_support.md Add playground branch 2022-04-27 18:19:56 +08:00
reference_glossary.md
support.md Add playground branch 2022-04-27 18:19:56 +08:00
syllabus.md Add playground branch 2022-04-27 18:19:56 +08:00
translating.md Add playground branch 2022-04-27 18:19:56 +08:00
zh_cn_doc_status.sh Add playground branch 2022-04-27 18:19:56 +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 有许多 特性来探索,也有很多 参考文档 供您发掘。你可以通过修改 布局键码来利用许多特性。