9ea9806d67
* Set up language fallback for docs, and update translation guidelines * Title Case * Add ID example * Link to emoji flag cheatsheet * Move docs preview section to contributing.md * Point to docs preview in the readme |
||
|---|---|---|
| .. | ||
| ChangeLog | ||
| de | ||
| es | ||
| fr-fr | ||
| gitbook/images | ||
| he-il | ||
| ja | ||
| ru-ru | ||
| zh-cn | ||
| .nojekyll | ||
| CNAME | ||
| README.md | ||
| _langs.md | ||
| _summary.md | ||
| arm_debugging.md | ||
| becoming_a_qmk_collaborator.md | ||
| breaking_changes.md | ||
| cli.md | ||
| cli_configuration.md | ||
| cli_development.md | ||
| coding_conventions_c.md | ||
| coding_conventions_python.md | ||
| compatible_microcontrollers.md | ||
| config_options.md | ||
| contributing.md | ||
| custom_quantum_functions.md | ||
| documentation_best_practices.md | ||
| documentation_templates.md | ||
| driver_installation_zadig.md | ||
| faq.md | ||
| faq_build.md | ||
| faq_debug.md | ||
| faq_general.md | ||
| faq_keymap.md | ||
| feature_advanced_keycodes.md | ||
| feature_audio.md | ||
| feature_auto_shift.md | ||
| feature_backlight.md | ||
| feature_bluetooth.md | ||
| feature_bootmagic.md | ||
| feature_combo.md | ||
| feature_command.md | ||
| feature_debounce_type.md | ||
| feature_dip_switch.md | ||
| feature_dynamic_macros.md | ||
| feature_encoders.md | ||
| feature_grave_esc.md | ||
| feature_haptic_feedback.md | ||
| feature_hd44780.md | ||
| feature_key_lock.md | ||
| feature_layouts.md | ||
| feature_leader_key.md | ||
| feature_led_matrix.md | ||
| feature_macros.md | ||
| feature_mouse_keys.md | ||
| feature_oled_driver.md | ||
| feature_pointing_device.md | ||
| feature_ps2_mouse.md | ||
| feature_rgb_matrix.md | ||
| feature_rgblight.md | ||
| feature_space_cadet.md | ||
| feature_split_keyboard.md | ||
| feature_stenography.md | ||
| feature_swap_hands.md | ||
| feature_tap_dance.md | ||
| feature_terminal.md | ||
| feature_thermal_printer.md | ||
| feature_unicode.md | ||
| feature_userspace.md | ||
| feature_velocikey.md | ||
| features.md | ||
| flashing.md | ||
| flashing_bootloadhid.md | ||
| fuse.txt | ||
| getting_started_build_tools.md | ||
| getting_started_getting_help.md | ||
| getting_started_github.md | ||
| getting_started_introduction.md | ||
| getting_started_make_guide.md | ||
| getting_started_vagrant.md | ||
| hand_wire.md | ||
| hardware.md | ||
| hardware_avr.md | ||
| hardware_drivers.md | ||
| hardware_keyboard_guidelines.md | ||
| how_keyboards_work.md | ||
| i2c_driver.md | ||
| index.html | ||
| internals_defines.md | ||
| internals_gpio_control.md | ||
| internals_input_callback_reg.md | ||
| internals_midi_device.md | ||
| internals_midi_device_setup_process.md | ||
| internals_midi_util.md | ||
| internals_send_functions.md | ||
| internals_sysex_tools.md | ||
| isp_flashing_guide.md | ||
| keycodes.md | ||
| keycodes_basic.md | ||
| keycodes_us_ansi_shifted.md | ||
| keymap.md | ||
| newbs.md | ||
| newbs_best_practices.md | ||
| newbs_building_firmware.md | ||
| newbs_building_firmware_configurator.md | ||
| newbs_flashing.md | ||
| newbs_getting_started.md | ||
| newbs_learn_more_resources.md | ||
| newbs_testing_debugging.md | ||
| other_eclipse.md | ||
| other_vscode.md | ||
| porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md | ||
| power.txt | ||
| proton_c_conversion.md | ||
| qmk.css | ||
| quantum_keycodes.md | ||
| redirects.json | ||
| ref_functions.md | ||
| reference_configurator_support.md | ||
| reference_glossary.md | ||
| reference_info_json.md | ||
| sidebar.css | ||
| support.md | ||
| sw.js | ||
| translating.md | ||
| understanding_qmk.md | ||
| unit_testing.md | ||
| usb_nkro.txt | ||
| ws2812_driver.md | ||
README.md
Quantum Mechanical Keyboard Firmware
What is QMK Firmware?
QMK (Quantum Mechanical Keyboard) is an open source community that maintains QMK Firmware, QMK Toolbox, 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
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 clone it directly with git clone https://github.com/qmk/qmk_firmware. Do not download the zip or tar files; a git repository is required to download the submodules in order 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
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.