홈 탐색 도움말
가입하기 로그인
HuiJun
/
qmk_firmware
1
0
포크 0
파일 이슈 0 풀 리퀘스트 0 위키
트리: cd0c089b49
브랜치 태그
qmk_firmware
/
docs
Drashna Jaelre 6835ae8209 Add the ability to disable Music Mode completely (#2339) 7 년 전
..
gitbook 4580d3a730 RGB improvements (#1684) 7 년 전
README.md 7b0356d1d4 Convert all headings to Title Case 7 년 전
_summary.md 7b0356d1d4 Convert all headings to Title Case 7 년 전
becoming_a_qmk_collaborator.md 7b0356d1d4 Convert all headings to Title Case 7 년 전
compatible_microcontrollers.md 7b0356d1d4 Convert all headings to Title Case 7 년 전
config_options.md 4764e77121 Clarify that we actually have max 16 total backlight levels 7 년 전
contributing.md bb53635f33 Trim trailing whitespace 7 년 전
custom_quantum_functions.md d8f0faabda Fixed typo 7 년 전
documentation_best_practices.md af37bb2f78 Fix some of the more obvious typos 7 년 전
documentation_templates.md 800ec55dfc Make arguments redo, subproject elimination (#1784) 7 년 전
eclipse.md 7b0356d1d4 Convert all headings to Title Case 7 년 전
faq.md e6c638bed1 Overhaul the Getting Started section and add a FAQ section 7 년 전
faq_build.md bb53635f33 Trim trailing whitespace 7 년 전
faq_debug.md bb53635f33 Trim trailing whitespace 7 년 전
faq_general.md 7b0356d1d4 Convert all headings to Title Case 7 년 전
faq_keymap.md 4931510ad3 backlight breathing overhaul (#2187) 7 년 전
feature_advanced_keycodes.md bb53635f33 Trim trailing whitespace 7 년 전
feature_audio.md 6835ae8209 Add the ability to disable Music Mode completely (#2339) 7 년 전
feature_auto_shift.md 4f484bc1c9 Add on/off/toggle keycodes for Auto Shift 7 년 전
feature_backlight.md 4764e77121 Clarify that we actually have max 16 total backlight levels 7 년 전
feature_bluetooth.md 4c675a83ba Format keycode tables 7 년 전
feature_bootmagic.md 4c675a83ba Format keycode tables 7 년 전
feature_dynamic_macros.md bb53635f33 Trim trailing whitespace 7 년 전
feature_grave_esc.md 4c675a83ba Format keycode tables 7 년 전
feature_key_lock.md 7b0356d1d4 Convert all headings to Title Case 7 년 전
feature_layouts.md 2018df1a61 Clarify the format for layout names 7 년 전
feature_leader_key.md 7b0356d1d4 Convert all headings to Title Case 7 년 전
feature_macros.md bb53635f33 Trim trailing whitespace 7 년 전
feature_mouse_keys.md af37bb2f78 Fix some of the more obvious typos 7 년 전
feature_pointing_device.md af37bb2f78 Fix some of the more obvious typos 7 년 전
feature_ps2_mouse.md bb53635f33 Trim trailing whitespace 7 년 전
feature_rgblight.md 6c24e28b8d ADD RGBLIGHT_LIMIT_VAL (#2214) 7 년 전
feature_space_cadet.md af37bb2f78 Fix some of the more obvious typos 7 년 전
feature_space_shift_cadet.md 8a1e656099 new planck keymap, new feature - hybrid shift/enter action key (great for small keyboards!) (#2100) 7 년 전
feature_stenography.md af37bb2f78 Fix some of the more obvious typos 7 년 전
feature_tap_dance.md bb53635f33 Trim trailing whitespace 7 년 전
feature_terminal.md bb53635f33 Trim trailing whitespace 7 년 전
feature_thermal_printer.md 4c675a83ba Format keycode tables 7 년 전
feature_unicode.md af37bb2f78 Fix some of the more obvious typos 7 년 전
feature_userspace.md bb53635f33 Trim trailing whitespace 7 년 전
features.md af37bb2f78 Fix some of the more obvious typos 7 년 전
flashing.md bb53635f33 Trim trailing whitespace 7 년 전
fuse.txt ca01d94005 convert docs to lowercase and underscores 8 년 전
getting_started_build_tools.md 4beb5e72f8 macOS also requires avrdude 7 년 전
getting_started_github.md 7b0356d1d4 Convert all headings to Title Case 7 년 전
getting_started_introduction.md 7b0356d1d4 Convert all headings to Title Case 7 년 전
getting_started_make_guide.md bb53635f33 Trim trailing whitespace 7 년 전
getting_started_vagrant.md af37bb2f78 Fix some of the more obvious typos 7 년 전
glossary.md bb53635f33 Trim trailing whitespace 7 년 전
hand_wire.md bb53635f33 Trim trailing whitespace 7 년 전
hardware.md af37bb2f78 Fix some of the more obvious typos 7 년 전
hardware_avr.md 4931510ad3 backlight breathing overhaul (#2187) 7 년 전
hardware_drivers.md 7b0356d1d4 Convert all headings to Title Case 7 년 전
hardware_keyboard_guidelines.md bb53635f33 Trim trailing whitespace 7 년 전
how_keyboards_work.md 7b0356d1d4 Convert all headings to Title Case 7 년 전
isp_flashing_guide.md bb53635f33 Trim trailing whitespace 7 년 전
keycode.txt bb53635f33 Trim trailing whitespace 7 년 전
keycodes.md cfcf0fd36b Remove reference to BL_x in keycodes.md, and add BL_BRTG 7 년 전
keycodes_basic.md 4c675a83ba Format keycode tables 7 년 전
keycodes_us_ansi_shifted.md bb53635f33 Trim trailing whitespace 7 년 전
keymap.md bb53635f33 Trim trailing whitespace 7 년 전
porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md af37bb2f78 Fix some of the more obvious typos 7 년 전
power.txt bb53635f33 Trim trailing whitespace 7 년 전
quantum_keycodes.md bb53635f33 Trim trailing whitespace 7 년 전
redirects.json 67cc5cebc0 Restructure the hardware and feature docs to make things easier to find (#1888) 7 년 전
understanding_qmk.md bb53635f33 Trim trailing whitespace 7 년 전
unit_testing.md bb53635f33 Trim trailing whitespace 7 년 전
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores 8 년 전

README.md

Quantum Mechanical Keyboard Firmware

What is QMK Firmware? {#what-is-qmk-firmware}

QMK (Quantum Mechanical Keyboard) is an open source community that maintains QMK Firmware, QMK Flasher, qmk.fm, and these docs. QMK Firmware is a keyboard firmware based on the tmk_keyboard with some useful features for Atmel AVR controllers, and more specifically, the OLKB product line, the ErgoDox EZ keyboard, and the Clueboard product line. It has also been ported to ARM chips using ChibiOS. You can use it to power your own hand-wired or custom keyboard PCB.

How to Get It {#how-to-get-it}

If you plan on contributing a keymap, keyboard, or features to QMK, the easiest thing to do is fork the repo through Github, and clone your repo locally to make your changes, push them, then open a Pull Request from your fork.

Otherwise, you can either download it directly (zip, tar), or clone it via git (git@github.com:qmk/qmk_firmware.git), or https (https://github.com/qmk/qmk_firmware.git).

How to Compile {#how-to-compile}

Before you are able to compile, you'll need to install an environment for AVR or/and ARM development. Once that is complete, you'll use the make command to build a keyboard and keymap with the following notation:

make planck/rev4:default

This would build the rev4 revision of the planck with the default keymap. Not all keyboards have revisions (also called subprojects or folders), in which case, it can be omitted:

make preonic:default

How to Customize {#how-to-customize}

QMK has lots of features to explore, and a good deal of reference documentation to dig through. Most features are taken advantage of by modifying your keymap, and changing the keycodes.