James Young
fced377ac0
* 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" |
4 years ago | |
---|---|---|
.. | ||
README.md | Fix capitalisation of "GitHub" (#9184) | 4 years ago |
_summary.md | Fix capitalisation of "GitHub" (#9184) | 4 years ago |
contributing.md | translate docs into Mandarin Chinese (#5807) | 5 years ago |
custom_quantum_functions.md | 2020 May 30 Breaking Changes Update (#9215) | 4 years ago |
faq.md | translate docs into Mandarin Chinese (#5807) | 5 years ago |
faq_build.md | Remove mbed files (#7605) | 4 years ago |
faq_debug.md | Remove Atmel FLIP from install scripts and documentation (#8822) | 4 years ago |
faq_general.md | docs to Mandarin Chinese (#5960) | 5 years ago |
faq_keymap.md | [Docs] Remove some outdated FAQ items (#7607) | 4 years ago |
getting_started_getting_help.md | Fix capitalisation of "GitHub" (#9184) | 4 years ago |
getting_started_github.md | Fix capitalisation of "GitHub" (#9184) | 4 years ago |
getting_started_introduction.md | [Docs] fix docs (#7642) | 4 years ago |
newbs.md | translate docs into Mandarin Chinese (#5807) | 5 years ago |
newbs_best_practices.md | translate the first unit(newbs) (#5753) | 5 years ago |
newbs_building_firmware.md | Fix capitalisation of "GitHub" (#9184) | 4 years ago |
newbs_flashing.md | translate the first unit(newbs) (#5753) | 5 years ago |
newbs_getting_started.md | translate the first unit(newbs) (#5753) | 5 years ago |
newbs_learn_more_resources.md | translate the first unit(newbs) (#5753) | 5 years ago |
newbs_testing_debugging.md | [Docs] Replace Switch Hitter link with Wayback Machine link (#7009) | 4 years ago |
reference_glossary.md | Remove Atmel FLIP from install scripts and documentation (#8822) | 4 years ago |
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