qmk_firmware/docs/zh-cn
James Young fced377ac0
2020 May 30 Breaking Changes Update (#9215)
* Branch point for 2020 May 30 Breaking Change

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

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

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

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

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

* Convert V-USB usbdrv to a submodule (#8321)

* Unify Tap Hold functions and documentation (#8348)

* Changing board names to prevent confusion (#8412)

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

* Move spaceman keyboards (#8830)

* Migrate miscellaneous `fn_actions` entries (#8977)

* Migrate `ACTION_MODS_KEY` to chained mod keycodes (#8979)

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

* Refactor Lily58 to use split_common (#6260)

* Refactor zinc to use split_common (#7114)

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

* Fix conflicting types for 'tfp_printf' (#8269)

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

* Refactor and updates to TKC1800 code (#8472)

* Switch to qmk forks for everything (#9019)

* audio refactor: replace deprecated PLAY_NOTE_ARRAY (#8484)

* Audio enable corrections (2/3) (#8903)

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

* Audio enable corrections (Part 4) (#8974)

* Fix typo from PR7114 (#9171)

* Augment future branch Changelogs (#8978)

* Revert "Branch point for 2020 May 30 Breaking Change"
2020-05-30 13:14:59 -07:00
..
README.md Fix capitalisation of "GitHub" (#9184) 2020-05-25 19:43:14 -07:00
_summary.md Fix capitalisation of "GitHub" (#9184) 2020-05-25 19:43:14 -07:00
contributing.md
custom_quantum_functions.md 2020 May 30 Breaking Changes Update (#9215) 2020-05-30 13:14:59 -07:00
faq.md
faq_build.md
faq_debug.md Remove Atmel FLIP from install scripts and documentation (#8822) 2020-04-17 09:50:58 +02:00
faq_general.md
faq_keymap.md
getting_started_getting_help.md Fix capitalisation of "GitHub" (#9184) 2020-05-25 19:43:14 -07:00
getting_started_github.md Fix capitalisation of "GitHub" (#9184) 2020-05-25 19:43:14 -07:00
getting_started_introduction.md
newbs.md
newbs_best_practices.md
newbs_building_firmware.md Fix capitalisation of "GitHub" (#9184) 2020-05-25 19:43:14 -07:00
newbs_flashing.md
newbs_getting_started.md
newbs_learn_more_resources.md
newbs_testing_debugging.md
reference_glossary.md Remove Atmel FLIP from install scripts and documentation (#8822) 2020-04-17 09:50:58 +02:00

README.md

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 有许多 特性来探索,也有很多 参考文档 供您发掘。你可以通过修改 布局键码来利用许多特性。