qmk_firmware/docs/zh-cn
ymzcdg 6a165c41cb
[Docs] doc update zh-cn (#8147)
* update zh-cn translate

Timestamp was added at the end of the document, it can help me manage version easier.

* fix _summary.md to utf-8

* fix _summary.md with vscode
2020-02-11 10:05:23 -08:00
..
README.md Add language prefixes to docs sidebar entries and readmes (#7406) 2019-11-26 18:22:13 +11:00
_summary.md [Docs] doc update zh-cn (#8147) 2020-02-11 10:05:23 -08:00
contributing.md translate docs into Mandarin Chinese (#5807) 2019-05-11 09:22:16 -07:00
custom_quantum_functions.md Fix file encoding for zh-cn/custom_quantum_functions.md (#7665) 2019-12-27 03:31:48 +00:00
faq.md translate docs into Mandarin Chinese (#5807) 2019-05-11 09:22:16 -07:00
faq_build.md Remove mbed files (#7605) 2019-12-11 11:36:00 -08:00
faq_debug.md [Docs] Remove some outdated FAQ items (#7607) 2019-12-11 11:33:09 -08:00
faq_general.md docs to Mandarin Chinese (#5960) 2019-06-04 11:06:17 -07:00
faq_keymap.md [Docs] Remove some outdated FAQ items (#7607) 2019-12-11 11:33:09 -08:00
getting_started_getting_help.md translate docs into Mandarin Chinese (#5807) 2019-05-11 09:22:16 -07:00
getting_started_github.md [Docs] fix docs (#7642) 2019-12-21 11:00:22 +00:00
getting_started_introduction.md [Docs] fix docs (#7642) 2019-12-21 11:00:22 +00:00
newbs.md translate docs into Mandarin Chinese (#5807) 2019-05-11 09:22:16 -07:00
newbs_best_practices.md
newbs_building_firmware.md
newbs_flashing.md
newbs_getting_started.md
newbs_learn_more_resources.md
newbs_testing_debugging.md [Docs] Replace Switch Hitter link with Wayback Machine link (#7009) 2019-10-15 23:21:05 +01:00
reference_glossary.md docs to Mandarin Chinese (#5960) 2019-06-04 11:06:17 -07: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 有许多 特性来探索,也有很多 参考文档 供您发掘。你可以通过修改 布局键码来利用许多特性。