mirror of https://github.com/qmk/qmk_firmware.git synced 2024-11-29 06:30:17 +00:00

History

tzarc e5cab0b3cf Deploying to gh-pages from master @ `88fe5c16a5` 🚀		2021-11-28 00:12:20 +00:00
..
_summary.md	Deploying to gh-pages from master @ `aae3b35c0f` 🚀	2020-11-10 15:02:44 +00:00
contributing.md	Deploying to gh-pages from master @ `92a787ca4c` 🚀	2021-01-30 11:02:49 +00:00
custom_quantum_functions.md	Deploying to gh-pages from master @ `45f88af4a1` 🚀	2021-09-21 23:42:09 +00:00
faq_build.md	Deploying to gh-pages from master @ `92a787ca4c` 🚀	2021-01-30 11:02:49 +00:00
faq_debug.md	Deploying to gh-pages from master @ `88fe5c16a5` 🚀	2021-11-28 00:12:20 +00:00
faq_general.md	Deploying to gh-pages from master @ `aae3b35c0f` 🚀	2020-11-10 15:02:44 +00:00
faq_keymap.md	Deploying to gh-pages from master @ `88fe5c16a5` 🚀	2021-11-28 00:12:20 +00:00
faq.md	Deploying to gh-pages from master @ `aae3b35c0f` 🚀	2020-11-10 15:02:44 +00:00
getting_started_getting_help.md	Deploying to gh-pages from master @ `aae3b35c0f` 🚀	2020-11-10 15:02:44 +00:00
getting_started_github.md	Deploying to gh-pages from master @ `88fe5c16a5` 🚀	2021-11-28 00:12:20 +00:00
getting_started_introduction.md	Deploying to gh-pages from master @ `aae3b35c0f` 🚀	2020-11-10 15:02:44 +00:00
newbs_best_practices.md	Deploying to gh-pages from master @ `aae3b35c0f` 🚀	2020-11-10 15:02:44 +00:00
newbs_building_firmware.md	Deploying to gh-pages from master @ `aae3b35c0f` 🚀	2020-11-10 15:02:44 +00:00
newbs_flashing.md	Deploying to gh-pages from master @ `aae3b35c0f` 🚀	2020-11-10 15:02:44 +00:00
newbs_getting_started.md	Deploying to gh-pages from master @ `92a787ca4c` 🚀	2021-01-30 11:02:49 +00:00
newbs_learn_more_resources.md	Deploying to gh-pages from master @ `aae3b35c0f` 🚀	2020-11-10 15:02:44 +00:00
newbs_testing_debugging.md	Deploying to gh-pages from master @ `92a787ca4c` 🚀	2021-01-30 11:02:49 +00:00
newbs.md	Deploying to gh-pages from master @ `92a787ca4c` 🚀	2021-01-30 11:02:49 +00:00
README.md	Deploying to gh-pages from master @ `c71d67ba3f` 🚀	2021-08-20 22:32:56 +00:00
reference_glossary.md	Deploying to gh-pages from master @ `92a787ca4c` 🚀	2021-01-30 11:02:49 +00:00

README.md

QMK机械键盘固件

什么是 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

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

make preonic:default

如何定制