qmk_firmware/docs
shela c1c0cf73ce fix typo 2019-07-01 15:32:59 +09:00
..
gitbook/images
zh
zh-cn Change from avr-gcc@7 to @8 for Mac 2019-06-05 17:51:39 -07:00
.nojekyll
CNAME
LANGS.md
README.md
_summary.md Additional link fixes 2019-05-22 21:00:20 -07:00
arm_debugging.md
becoming_a_qmk_collaborator.md
compatible_microcontrollers.md
config_options.md Fix breathing always on for soft PWM (#5983) 2019-06-19 22:33:39 -07:00
contributing.md Update our style guide (#5500) 2019-04-18 15:59:51 -07:00
custom_quantum_functions.md docs to Mandarin Chinese (#5960) 2019-06-04 11:06:17 -07:00
documentation_best_practices.md
documentation_templates.md
faq.md
faq_build.md Change from avr-gcc@7 to @8 for Mac 2019-06-05 17:51:39 -07:00
faq_debug.md
faq_general.md
faq_keymap.md Replace instances of KEYMAP with LAYOUT 2019-02-21 23:19:26 -08:00
feature_advanced_keycodes.md fix typo 2019-07-01 15:32:59 +09:00
feature_audio.md Adds a configurable initial delay to the audio clicky feature (#4286) 2019-05-17 13:48:53 -07:00
feature_auto_shift.md
feature_backlight.md Fix breathing always on for soft PWM (#5983) 2019-06-19 22:33:39 -07:00
feature_bluetooth.md
feature_bootmagic.md Replace DEBOUNCING_DELAY (deprecated) with DEBOUNCE (#5997) 2019-06-06 12:09:56 -07:00
feature_combo.md [Docs] Make Code Examples Consistent On Combo Page (#6078) 2019-06-05 11:18:20 -07:00
feature_command.md Change Command keycode defaults to match corresponding Bootmagic codes (#5078) 2019-02-17 22:23:32 -08:00
feature_debounce_type.md Eager Per Row Debouncing added (added to Ergodox) (#5498) 2019-04-03 14:45:55 -07:00
feature_dynamic_macros.md
feature_encoders.md Update feature_encoders.md 2019-05-30 17:00:21 -07:00
feature_grave_esc.md Document an annoyance with Grave Escape and macOS Terminal (#5483) 2019-03-24 17:11:26 -07:00
feature_haptic_feedback.md Haptic feedback generalized - DRV2605 and solenoids (#4939) 2019-02-16 18:39:30 -08:00
feature_hd44780.md
feature_key_lock.md
feature_layouts.md Add a mechanism for force building a particular community layout (#5027) 2019-02-14 20:14:26 -08:00
feature_leader_key.md
feature_led_matrix.md Add documentation for led matrix 2019-02-10 15:37:12 -08:00
feature_macros.md [Docs] Update Super ALT↯TAB to remove use of unregister_code16 (#5766) 2019-05-04 09:46:44 -07:00
feature_mouse_keys.md Update mouse keys docs (#5653) 2019-04-19 23:18:06 -07:00
feature_oled_driver.md Add SH1106 OLED support (#5787) 2019-06-11 15:27:17 -07:00
feature_pointing_device.md
feature_ps2_mouse.md
feature_rgb_matrix.md [Docs] Update feature_rgb_matrix.md (#6117) 2019-06-11 14:42:53 -07:00
feature_rgblight.md Add effect range to rgblight.c (#5856) 2019-05-15 21:11:28 -07:00
feature_space_cadet.md Added check for event pressed to clear space cadet (#5839) 2019-05-11 22:20:14 -07:00
feature_stenography.md
feature_swap_hands.md
feature_tap_dance.md [Docs] Add Tap Dance example to the docs (#5326) 2019-03-07 12:30:02 -08:00
feature_terminal.md
feature_thermal_printer.md
feature_unicode.md New keycode macro (XP) for shifted character pairs using UNICODEMAP + bug fixes and improvements (#4803) 2019-05-03 09:33:00 -07:00
feature_userspace.md [Docs] Fix typo in Userspace doc (#5871) 2019-05-16 08:21:51 -07:00
feature_velocikey.md Velocikey: Match RGB animation speed to typing speed (#3754) 2019-02-21 07:22:46 -08:00
features.md Fix typo 2019-05-23 10:29:18 -07:00
flashing.md Fix link to Caterina bootloader hex files (#5452) 2019-03-20 07:43:20 -07:00
fuse.txt
getting_started_build_tools.md Change from avr-gcc@7 to @8 for Mac 2019-06-05 17:51:39 -07:00
getting_started_getting_help.md
getting_started_github.md
getting_started_introduction.md [Docs] Update getting_started_introduction.md (#6037) 2019-05-31 14:44:27 -07:00
getting_started_make_guide.md Clean up debounce a bit (#5255) 2019-03-04 07:44:46 -08:00
getting_started_vagrant.md
hand_wire.md A better new_project.sh (#5191) 2019-04-27 16:42:16 -07:00
hardware.md
hardware_avr.md A better new_project.sh (#5191) 2019-04-27 16:42:16 -07:00
hardware_drivers.md OLED Driver Feature 2019-04-20 08:05:10 -07:00
hardware_keyboard_guidelines.md Clarify LAYOUT vs LAYOUT_all 2019-02-08 15:13:20 -08:00
how_keyboards_work.md docs to Mandarin Chinese (#5960) 2019-06-04 11:06:17 -07:00
i2c_driver.md Parameterise STM32 I2C pin modes and timing parameters. (#5671) 2019-06-01 16:04:09 -07:00
index.html use twitter card large setting for larger previews 2019-06-06 01:23:18 -04:00
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 ISP Flashing Guide - atmega32a info (#4993) 2019-03-22 18:26:21 -07:00
keycodes.md [Docs] Reword confusing description of `TO(layer)` (#6174) 2019-06-24 00:23:27 -07:00
keycodes_basic.md
keycodes_us_ansi_shifted.md
keymap.md [Docs] Smallish overhaul of the docs (#5281) 2019-03-18 14:22:02 -07:00
newbs.md
newbs_best_practices.md
newbs_building_firmware.md
newbs_building_firmware_configurator.md
newbs_flashing.md [Docs] Smallish overhaul of the docs (#5281) 2019-03-18 14:22:02 -07:00
newbs_getting_started.md [Docs] Recursively clone qmk_firmware repo (#5378) 2019-03-18 14:22:33 -07:00
newbs_learn_more_resources.md
newbs_testing_debugging.md [Docs] Add examples to debugging docs (#5555) 2019-05-03 17:24:07 -07:00
other_eclipse.md [Docs] Add VSCode guide to docs (#5124) 2019-03-15 14:34:58 -07:00
other_vscode.md [Docs] Add VSCode guide to docs (#5124) 2019-03-15 14:34:58 -07:00
porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md A better new_project.sh (#5191) 2019-04-27 16:42:16 -07:00
power.txt
proton_c_conversion.md
qmk.css
quantum_keycodes.md Added check for event pressed to clear space cadet (#5839) 2019-05-11 22:20:14 -07:00
redirects.json
ref_functions.md
reference_configurator_support.md Update reference_configurator_support.md 2019-05-31 11:54:01 -07:00
reference_glossary.md
reference_info_json.md Add label to the info.json reference 2019-02-08 15:13:20 -08:00
sidebar.css
support.md
sw.js
understanding_qmk.md [Docs] Smallish overhaul of the docs (#5281) 2019-03-18 14:22:02 -07:00
unit_testing.md
usb_nkro.txt

README.md

Quantum Mechanical Keyboard Firmware

Current Version Build Status Discord Docs Status GitHub contributors GitHub forks

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 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

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.