History

ridingqwerty 95c24bbaf8 Implement and document TAPPING_FORCE_HOLD_PER_KEY (#7859 ) * Implement and document TAPPING_FORCE_HOLD_PER_KEY * Added "record" parameter to "get_tapping_force_hold" * Correct typo -- remove 'IGNORE_' from 'IGNORE_TAPPING_FORCE_HOLD_PER_KEY' Co-authored-by: GeorgeKoenig <35542036+GeorgeKoenig@users.noreply.github.com>		2020-01-17 15:49:23 -05:00
..
ChangeLog	…
de	Add language prefixes to docs sidebar entries and readmes (#7406 )	2019-11-26 18:22:13 +11:00
es	Add language prefixes to docs sidebar entries and readmes (#7406 )	2019-11-26 18:22:13 +11:00
fr-fr	[Docs] fix docs (#7642 )	2019-12-21 11:00:22 +00:00
gitbook/images	…
he-il	Move Space Cadet keycodes to their own section in keycode reference (#7889 )	2020-01-14 14:02:13 +00:00
ja	Add per-key IGNORE_MOD_TAP_INTERRUPT feature (#7838 )	2020-01-10 02:48:06 -05:00
pt-br	[Docs] add README translation in portuguese (#7016 )	2019-12-10 10:19:12 -08:00
ru-ru	[Docs] fix docs (#7642 )	2019-12-21 11:00:22 +00:00
zh-cn	Fix file encoding for zh-cn/custom_quantum_functions.md (#7665 )	2019-12-27 03:31:48 +00:00
.nojekyll	…
CNAME	…
README.md	[Docs] Encourage newbs to not download the repo as a zip (#7353 )	2019-11-14 11:37:18 -08:00
_langs.md	[Docs] add README translation in portuguese (#7016 )	2019-12-10 10:19:12 -08:00
_summary.md	Improve support and docs for ADC driver (#7191 )	2019-12-08 12:11:29 +11:00
adc_driver.md	Improve support and docs for ADC driver (#7191 )	2019-12-08 12:11:29 +11:00
arm_debugging.md	[Docs] fix docs (#7642 )	2019-12-21 11:00:22 +00:00
becoming_a_qmk_collaborator.md	…
breaking_changes.md	Update Breaking Changes doc timeline	2020-01-09 11:19:47 -08:00
cli.md	Add CLI command for flashing a keyboard	2019-11-15 23:06:07 -08:00
cli_configuration.md	…
cli_development.md	Add flake8 to our test suite and fix all errors (#7379 )	2019-11-20 14:54:18 -08:00
coding_conventions_c.md	Minor grammar and filename fixes in docs (#7559 )	2019-12-07 23:19:18 +11:00
coding_conventions_python.md	Add a note explaining how to run tests	2020-01-14 07:52:14 -08:00
compatible_microcontrollers.md	[Doc] Tidy up compatible MCUs docs (#7295 )	2019-11-08 18:34:25 -08:00
config_options.md	Implement and document TAPPING_FORCE_HOLD_PER_KEY (#7859 )	2020-01-17 15:49:23 -05:00
contributing.md	Improve docs "Edit Document" footer	2019-12-18 14:01:13 +11:00
custom_quantum_functions.md	Add per-key IGNORE_MOD_TAP_INTERRUPT feature (#7838 )	2020-01-10 02:48:06 -05:00
documentation_best_practices.md	…
documentation_templates.md	Doc fix to conform with #7221 (#7392 )	2019-11-17 16:04:44 +00:00
driver_installation_zadig.md	…
faq.md	…
faq_build.md	[Docs] Update macOS related issues in docs (#7744 )	2019-12-31 14:33:54 +00:00
faq_debug.md	[Docs] Remove some outdated FAQ items (#7607 )	2019-12-11 11:33:09 -08:00
faq_general.md	…
faq_keymap.md	[Docs] Remove some outdated FAQ items (#7607 )	2019-12-11 11:33:09 -08:00
feature_advanced_keycodes.md	Implement and document TAPPING_FORCE_HOLD_PER_KEY (#7859 )	2020-01-17 15:49:23 -05:00
feature_audio.md	…
feature_auto_shift.md	Smallish overhaul of Auto-Shift feature (#6067 )	2019-11-03 09:52:01 -08:00
feature_backlight.md	Convert backlight to follow driver rules pattern - update docs	2019-12-14 03:25:06 +00:00
feature_bluetooth.md	Update feature_bluetooth.md (#7193 )	2019-10-30 09:43:01 +11:00
feature_bootmagic.md	Add short aliases for Magic keycodes (#7541 )	2019-12-05 00:44:39 -08:00
feature_combo.md	…
feature_command.md	…
feature_debounce_type.md	Update debounce docs (#7355 )	2019-11-14 18:54:34 +00:00
feature_dip_switch.md	…
feature_dynamic_macros.md	[Core] Convert Dynamic Macro to a Core Feature (#5948 )	2019-11-04 22:59:13 -08:00
feature_encoders.md	…
feature_grave_esc.md	…
feature_haptic_feedback.md	Minor grammar and filename fixes in docs (#7559 )	2019-12-07 23:19:18 +11:00
feature_hd44780.md	…
feature_key_lock.md	…
feature_layouts.md	…
feature_leader_key.md	Send string keycode tweaks (#7471 )	2019-11-25 23:16:58 -08:00
feature_led_matrix.md	…
feature_macros.md	Send string keycode tweaks (#7471 )	2019-11-25 23:16:58 -08:00
feature_mouse_keys.md	…
feature_oled_driver.md	Adds raw write functions to the OLED driver (#7237 )	2019-11-03 14:34:47 -08:00
feature_pointing_device.md	…
feature_ps2_mouse.md	…
feature_rgb_matrix.md	RGB matrix effect - left-right gradient (#7742 )	2020-01-07 21:25:17 +00:00
feature_rgblight.md	Add shift-to-invert to remaining directional RGB_* keycode pairs (#7484 )	2019-11-28 22:00:29 +00:00
feature_space_cadet.md	…
feature_split_keyboard.md	Update split i2c docs for example of when pull-ups are required (#7143 )	2019-10-28 18:10:25 +00:00
feature_stenography.md	…
feature_swap_hands.md	…
feature_tap_dance.md	[Docs] Explain Tap Dance interruption (#5520 )	2019-11-16 09:20:49 -08:00
feature_terminal.md	…
feature_thermal_printer.md	…
feature_unicode.md	…
feature_userspace.md	Send string keycode tweaks (#7471 )	2019-11-25 23:16:58 -08:00
feature_velocikey.md	…
features.md	…
flashing.md	[Docs] Update flashing information to include :flash target (#6999 )	2019-10-29 13:15:03 -07:00
flashing_bootloadhid.md	Install bootloadHid as part of qmk_install (#7463 )	2019-11-28 15:29:11 +00:00
fuse.txt	…
getting_started_build_tools.md	Fix docker script and document (#7786 )	2020-01-10 00:44:16 +00:00
getting_started_getting_help.md	…
getting_started_github.md	[Docs] fix docs (#7642 )	2019-12-21 11:00:22 +00:00
getting_started_introduction.md	[Docs] update git command and directory name of documents (#7619 )	2019-12-12 20:59:00 -08:00
getting_started_make_guide.md	Update getting_started_make_guide.md (#7538 )	2019-12-06 19:42:33 +11:00
getting_started_vagrant.md	[Docs] Update getting_started_vagrant.md (#7203 )	2019-10-30 11:53:48 -07:00
hand_wire.md	…
hardware.md	…
hardware_avr.md	…
hardware_drivers.md	ARM - ws2812 bitbang (#7173 )	2019-11-07 13:10:29 +00:00
hardware_keyboard_guidelines.md	…
how_keyboards_work.md	…
i2c_driver.md	…
index.html	Improve docs "Edit Document" footer	2019-12-18 14:01:13 +11: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	…
keycodes.md	Move Space Cadet keycodes to their own section in keycode reference (#7889 )	2020-01-14 14:02:13 +00:00
keycodes_basic.md	Remove obsolete note about media keys in MacOS (#6631 )	2019-10-30 10:39:38 +11:00
keycodes_us_ansi_shifted.md	…
keymap.md	…
newbs.md	Change newbs.md to link to the new newbs_git_best_practices.md instead of newbs_best_practices.md. (#7633 )	2019-12-14 18:16:31 +00:00
newbs_building_firmware.md	Fixed a small typo (#7743 )	2020-01-03 08:06:46 +11:00
newbs_building_firmware_configurator.md	…
newbs_flashing.md	[Docs] Update flashing information to include :flash target (#6999 )	2019-10-29 13:15:03 -07:00
newbs_getting_started.md	…
newbs_git_best_practices.md	[Docs] Restructure of Git Best Practices doc (#7231 )	2019-12-02 18:47:02 -08:00
newbs_git_resolving_merge_conflicts.md	[Docs] Restructure of Git Best Practices doc (#7231 )	2019-12-02 18:47:02 -08:00
newbs_git_resynchronize_a_branch.md	[Docs] Fix minor differences in docs/newbs_git_resynchronize_a_branch.md (#7728 )	2019-12-27 14:31:23 -08:00
newbs_git_using_your_master_branch.md	[Docs] Restructure of Git Best Practices doc (#7231 )	2019-12-02 18:47:02 -08:00
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	Update feature support for Proton C (#7596 )	2019-12-10 18:31:39 -05:00
qmk.css	…
quantum_keycodes.md	Move Space Cadet keycodes to their own section in keycode reference (#7889 )	2020-01-14 14:02:13 +00:00
redirects.json	…
ref_functions.md	…
reference_configurator_support.md	…
reference_glossary.md	…
reference_info_json.md	…
sidebar.css	…
support.md	…
sw.js	…
translating.md	Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504 )	2019-11-28 22:14:04 +00:00
understanding_qmk.md	…
unit_testing.md	…
usb_nkro.txt	…
ws2812_driver.md	SPI DMA based RGB Underglow for STM32 (#7674 )	2019-12-31 17:26:40 +00:00

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.