Kevin Foley cdb967f22b Fix link to command page 7 年之前
..
gitbook 4580d3a730 RGB improvements (#1684) 7 年之前
README.md 7b0356d1d4 Convert all headings to Title Case 7 年之前
_summary.md ae7284edb8 rename api docs to internals 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 22215a0e92 Added support for audio using pins C4, C5, B6, B7 7 年之前
contributing.md bb53635f33 Trim trailing whitespace 7 年之前
custom_quantum_functions.md d965d72d4a Fix custom functions documation for layer_state_set* 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 8e99fbc884 Fixed typo of 'confid.h' to 'config.h' (#2448) 7 年之前
faq.md e6c638bed1 Overhaul the Getting Started section and add a FAQ section 7 年之前
faq_build.md 07b90db897 Fixes and updates to docs (#2611) 7 年之前
faq_debug.md bb53635f33 Trim trailing whitespace 7 年之前
faq_general.md 7b0356d1d4 Convert all headings to Title Case 7 年之前
faq_keymap.md e87c39d302 More thoroughly document Bootmagic and Command (#2455) 7 年之前
feature_advanced_keycodes.md 07b90db897 Fixes and updates to docs (#2611) 7 年之前
feature_audio.md 22215a0e92 Added support for audio using pins C4, C5, B6, B7 7 年之前
feature_auto_shift.md d0054c41e2 Fix typo in autoshift docs: statn (#2579) 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 cdb967f22b Fix link to command page 7 年之前
feature_command.md e87c39d302 More thoroughly document Bootmagic and Command (#2455) 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 3f1d147529 Add SS_RALT for AltGR usage in macros 7 年之前
feature_mouse_keys.md 7f7f763598 Fixed dead links (#2451) 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 331288233d Add rgblist to docs 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 c0baf2a964 Improve state/chord handling and clean up namespace 7 年之前
feature_swap_hands.md 23ac2a02ef Add keycodes for swap-hands feature. 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 162a67cbc5 Add userspace config.h handling to build script (#2640) 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 767f7a8cf0 Fixed formatting for Fedora example 7 年之前
getting_started_getting_help.md 08e48eb6f5 Add a newbie guide for people completely new to QMK (#2480) 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 年之前
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 3b525dcf9c Remove obsolete info.json entries (#2712) 7 年之前
how_keyboards_work.md 7b0356d1d4 Convert all headings to Title Case 7 年之前
internals_defines.md ae7284edb8 rename api docs to internals 7 年之前
internals_input_callback_reg.md ae7284edb8 rename api docs to internals 7 年之前
internals_midi_device.md ae7284edb8 rename api docs to internals 7 年之前
internals_midi_device_setup_process.md ae7284edb8 rename api docs to internals 7 年之前
internals_midi_util.md ae7284edb8 rename api docs to internals 7 年之前
internals_send_functions.md ae7284edb8 rename api docs to internals 7 年之前
internals_sysex_tools.md ae7284edb8 rename api docs to internals 7 年之前
isp_flashing_guide.md bb53635f33 Trim trailing whitespace 7 年之前
keycode.txt bb53635f33 Trim trailing whitespace 7 年之前
keycodes.md 7a5ce36f23 Add macro for momentarily switching to a layer while some mods are active (#2460) 7 年之前
keycodes_basic.md a2e12faa19 Add CMD and WIN aliases for KC_GUI, GUI(kc), GUI_T(kc), etc. 7 年之前
keycodes_us_ansi_shifted.md bb53635f33 Trim trailing whitespace 7 年之前
keymap.md 07b90db897 Fixes and updates to docs (#2611) 7 年之前
newbs.md 48e11240a6 Move the linux tutorials to an info box on newbs_getting_started 7 年之前
newbs_building_firmware.md 75354f12d7 warn->danger 7 年之前
newbs_flashing.md ee1bb85542 Expand Newb Guide flashing document (#2588) 7 年之前
newbs_getting_started.md 48e11240a6 Move the linux tutorials to an info box on newbs_getting_started 7 年之前
newbs_testing_debugging.md 08e48eb6f5 Add a newbie guide for people completely new to QMK (#2480) 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 566399794a Disable the glossary linking to fix #2498 (#2499) 7 年之前
reference_glossary.md 566399794a Disable the glossary linking to fix #2498 (#2499) 7 年之前
understanding_qmk.md 7f7f763598 Fixed dead links (#2451) 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.