qmk_firmware/docs/zh-cn
ymzcdg 36bed36cd6 getting_started_introduction.md ->zh-cn (#5767)
translate getting_started_introduction.md into Mandarin Chinese
2019-05-03 06:18:20 -07:00
..
README.md Translate docs into Chinese (#5693) 2019-04-23 12:37:20 -07:00
_summary.md Translate docs into Chinese (#5693) 2019-04-23 12:37:20 -07:00
getting_started_introduction.md getting_started_introduction.md ->zh-cn (#5767) 2019-05-03 06:18:20 -07:00
newbs_best_practices.md translate the first unit(newbs) (#5753) 2019-05-02 22:21:06 -07:00
newbs_building_firmware.md translate the first unit(newbs) (#5753) 2019-05-02 22:21:06 -07:00
newbs_flashing.md translate the first unit(newbs) (#5753) 2019-05-02 22:21:06 -07:00
newbs_getting_started.md translate the first unit(newbs) (#5753) 2019-05-02 22:21:06 -07:00
newbs_learn_more_resources.md translate the first unit(newbs) (#5753) 2019-05-02 22:21:06 -07:00
newbs_testing_debugging.md translate the first unit(newbs) (#5753) 2019-05-02 22:21:06 -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 有许多 特性来探索,也有很多 参考文档 供您发掘。你可以通过修改 布局键码来利用许多特性。