History

hmkemppainen e676278474 fix instructions for oneshot layer handling on key release (#7554 ) * fix instructions for oneshot layer handling on key release * use ONESHOT_OTHER_KEY_PRESSED instead of ONESHOT_PRESSED Co-Authored-By: Drashna Jaelre <drashna@live.com>		2019-12-08 02:18:05 +00:00
..
ChangeLog	consistency	2019-08-30 15:01:52 -07:00
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	Add language prefixes to docs sidebar entries and readmes (#7406 )	2019-11-26 18:22:13 +11:00
gitbook/images	RGB improvements (#1684 )	2017-09-06 14:49:19 -07:00
he-il	Add language prefixes to docs sidebar entries and readmes (#7406 )	2019-11-26 18:22:13 +11:00
ja	[Docs] add japanese translations (#7454 )	2019-12-02 11:12:02 -08:00
ru-ru	[Docs] Creating RU version of getting_started_introduction (#7224 )	2019-12-06 11:25:05 -08:00
zh-cn	Add language prefixes to docs sidebar entries and readmes (#7406 )	2019-11-26 18:22:13 +11:00
_langs.md	[Docs] Fix Japanese country flag (#7407 )	2019-11-19 00:38:50 -08:00
_summary.md	Improve support and docs for ADC driver (#7191 )	2019-12-08 12:11:29 +11:00
.nojekyll	Use docsfy to replace gitbook	2018-05-07 22:46:26 -07:00
adc_driver.md	Improve support and docs for ADC driver (#7191 )	2019-12-08 12:11:29 +11:00
arm_debugging.md	Fixed typos in documentation (#6871 )	2019-10-02 16:41:32 -04:00
becoming_a_qmk_collaborator.md	Tweak the wording in "Becoming a QMK Collaborator"	2018-08-30 07:39:58 -04:00
breaking_changes.md	Update the breaking changes process so we always have a future branch (#6785 )	2019-09-21 11:58:06 -07:00
cli_configuration.md	Configuration system for CLI (#6708 )	2019-09-22 13:25:33 -07:00
cli_development.md	Add flake8 to our test suite and fix all errors (#7379 )	2019-11-20 14:54:18 -08:00
cli.md	Add CLI command for flashing a keyboard	2019-11-15 23:06:07 -08:00
CNAME	Create CNAME	2018-05-21 16:29:37 -04: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	Minor grammar and filename fixes in docs (#7559 )	2019-12-07 23:19:18 +11:00
compatible_microcontrollers.md	[Doc] Tidy up compatible MCUs docs (#7295 )	2019-11-08 18:34:25 -08:00
config_options.md	Unify RGB and RGBW commands (#7297 )	2019-11-09 15:51:39 +00:00
contributing.md	Set up language fallback for docs, and update translation guidelines (#7403 )	2019-11-23 16:07:15 +00:00
custom_quantum_functions.md	Update led_update_kb example (#7451 )	2019-11-23 15:37:25 +00:00
documentation_best_practices.md	Fix up info boxes.	2018-05-07 22:46:26 -07:00
documentation_templates.md	Doc fix to conform with #7221 (#7392 )	2019-11-17 16:04:44 +00:00
driver_installation_zadig.md	Add a short explanation to Zadig the troubleshooting section (#7110 )	2019-10-22 14:05:33 +11:00
faq_build.md	Install bootloadHid as part of qmk_install (#7463 )	2019-11-28 15:29:11 +00:00
faq_debug.md	[Docs] Modified the description about setting debug_enable in `docs/faq_debug.md`. (#7394 )	2019-11-17 17:09:57 -08:00
faq_general.md	Remove unanswered/unnecessary FAQ item	2019-10-07 15:43:42 -07:00
faq_keymap.md	Remove obsolete note about media keys in MacOS (#6631 )	2019-10-30 10:39:38 +11:00
faq.md	Overhaul the Getting Started section and add a FAQ section	2017-08-16 15:47:20 -04:00
feature_advanced_keycodes.md	fix instructions for oneshot layer handling on key release (#7554 )	2019-12-08 02:18:05 +00:00
feature_audio.md	Added keycodes for swapping and unswapping the Control and OS keys (#6110 )	2019-08-21 17:07:08 -07:00
feature_auto_shift.md	Smallish overhaul of Auto-Shift feature (#6067 )	2019-11-03 09:52:01 -08:00
feature_backlight.md	Initial migration of software PWM backlight (#6709 )	2019-11-02 21:20:03 +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	Change "yu" to "you" in combo docs (#6510 )	2019-08-08 18:10:16 +01:00
feature_command.md	Update IS_COMMAND definitions to use MOD_MASK_SHIFT (#6348 )	2019-07-20 13:21:40 -07:00
feature_debounce_type.md	Update debounce docs (#7355 )	2019-11-14 18:54:34 +00:00
feature_dip_switch.md	Add Dip Switch as a core feature (#6140 )	2019-09-03 08:34:31 -07:00
feature_dynamic_macros.md	[Core] Convert Dynamic Macro to a Core Feature (#5948 )	2019-11-04 22:59:13 -08:00
feature_encoders.md	Add support for different encoder pinout for right half of split keyboard (#6521 )	2019-08-16 16:46:41 -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	Minor grammar and filename fixes in docs (#7559 )	2019-12-07 23:19:18 +11:00
feature_hd44780.md	Remove build option firmware size impacts (#6947 )	2019-10-18 18:14:49 -07:00
feature_key_lock.md	update one shot keys link (#7020 )	2019-10-14 01:26:03 +01:00
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	Send string keycode tweaks (#7471 )	2019-11-25 23:16:58 -08:00
feature_led_matrix.md	Add documentation for led matrix	2019-02-10 15:37:12 -08:00
feature_macros.md	Send string keycode tweaks (#7471 )	2019-11-25 23:16:58 -08:00
feature_mouse_keys.md	Update mouse keys docs (#5653 )	2019-04-19 23:18:06 -07:00
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	Fix some of the more obvious typos	2017-12-09 10:46:11 -05:00
feature_ps2_mouse.md	[Docs] Removed dead link (#6922 )	2019-10-06 07:56:35 -07:00
feature_rgb_matrix.md	Minor grammar and filename fixes in docs (#7559 )	2019-12-07 23:19:18 +11: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	Added mod carry over from press to release. (#5866 )	2019-07-06 21:00:05 -07:00
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	Improve state/chord handling and clean up namespace	2018-04-07 17:12:44 -04:00
feature_swap_hands.md	fix swap_hands keycodes in documentation (#3588 )	2018-08-07 14:20:29 -07:00
feature_tap_dance.md	[Docs] Explain Tap Dance interruption (#5520 )	2019-11-16 09:20:49 -08:00
feature_terminal.md	Remove build option firmware size impacts (#6947 )	2019-10-18 18:14:49 -07:00
feature_thermal_printer.md	Format keycode tables	2017-12-09 10:46:11 -05:00
feature_unicode.md	[Docs] Clarify the rules.mk setup for Unicode (#6286 )	2019-07-11 11:33:55 -07:00
feature_userspace.md	Send string keycode tweaks (#7471 )	2019-11-25 23:16:58 -08:00
feature_velocikey.md	Velocikey: Match RGB animation speed to typing speed (#3754 )	2019-02-21 07:22:46 -08:00
features.md	Add Dip Switch as a core feature (#6140 )	2019-09-03 08:34:31 -07:00
flashing_bootloadhid.md	Install bootloadHid as part of qmk_install (#7463 )	2019-11-28 15:29:11 +00:00
flashing.md	[Docs] Update flashing information to include :flash target (#6999 )	2019-10-29 13:15:03 -07:00
fuse.txt	convert docs to lowercase and underscores	2017-06-10 14:58:24 -04:00
getting_started_build_tools.md	[Docs] Encourage newbs to not download the repo as a zip (#7353 )	2019-11-14 11:37:18 -08:00
getting_started_getting_help.md	Replace gitter links with Discord. (#3368 )	2018-07-11 00:01:56 -07:00
getting_started_github.md	Fix doc typo	2018-10-15 16:58:03 -07:00
getting_started_introduction.md	[Docs] Update getting_started_introduction.md (#6037 )	2019-05-31 14:44:27 -07: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	[Docs] Fixed internal links on Handwire page (#7154 )	2019-10-25 18:16:17 -07:00
hardware_avr.md	Remove apostrophe from various abbreviations' plural forms (#7050 )	2019-10-22 13:47:43 +01:00
hardware_drivers.md	ARM - ws2812 bitbang (#7173 )	2019-11-07 13:10:29 +00:00
hardware_keyboard_guidelines.md	Fixed typos in documentation (#6871 )	2019-10-02 16:41:32 -04:00
hardware.md	Fix some of the more obvious typos	2017-12-09 10:46:11 -05:00
how_keyboards_work.md	Update URL for `60-keyboard.hwdb` (#7185 )	2019-10-28 02:41:22 +00:00
i2c_driver.md	[Docs] Update i2c_driver.md (#6665 )	2019-09-03 10:09:58 -07:00
index.html	Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504 )	2019-11-28 22:14:04 +00:00
internals_defines.md	rename api docs to internals	2018-03-26 11:43:37 -07:00
internals_gpio_control.md	[Docs] Add AVR and ARM examples to GPIO Commands (#6942 )	2019-10-07 19:08:14 -07:00
internals_input_callback_reg.md	rename api docs to internals	2018-03-26 11:43:37 -07:00
internals_midi_device_setup_process.md	rename api docs to internals	2018-03-26 11:43:37 -07:00
internals_midi_device.md	rename api docs to internals	2018-03-26 11:43:37 -07:00
internals_midi_util.md	rename api docs to internals	2018-03-26 11:43:37 -07:00
internals_send_functions.md	rename api docs to internals	2018-03-26 11:43:37 -07:00
internals_sysex_tools.md	rename api docs to internals	2018-03-26 11:43:37 -07:00
isp_flashing_guide.md	ISP Flashing Guide - atmega32a info (#4993 )	2019-03-22 18:26:21 -07: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	Backslash-escape pipe character in keycode lists (#7157 )	2019-10-26 06:10:03 +01:00
keycodes.md	Add short aliases for Magic keycodes (#7541 )	2019-12-05 00:44:39 -08:00
keymap.md	[Docs] Smallish overhaul of the docs (#5281 )	2019-03-18 14:22:02 -07:00
newbs_building_firmware_configurator.md	Update YouTube URL	2019-07-29 10:12:22 -07:00
newbs_building_firmware.md	[Docs] Clean up docs/newbs_building_firmware.md (#6930 )	2019-10-07 20:08:05 -07:00
newbs_flashing.md	[Docs] Update flashing information to include :flash target (#6999 )	2019-10-29 13:15:03 -07:00
newbs_getting_started.md	[Docs] Recursively clone qmk_firmware repo (#5378 )	2019-03-18 14:22:33 -07:00
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] Restructure of Git Best Practices doc (#7231 )	2019-12-02 18:47:02 -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	Docs: Adding QMK Git Conventions doc; formatting cleanup on Learning Resources doc (#3902 )	2018-10-18 15:12:11 -07:00
newbs_testing_debugging.md	[Docs] Replace Switch Hitter link with Wayback Machine link (#7009 )	2019-10-15 23:21:05 +01:00
newbs.md	Contribute the MechMerlin QMK Configurator docs (#4986 )	2019-01-28 17:31:33 -08: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	Improve backlight PWM pin support (#6202 )	2019-08-08 13:12:12 -07:00
power.txt	Trim trailing whitespace	2017-12-09 10:46:11 -05:00
proton_c_conversion.md	Use task driven PWM for CTPC until ARM can provide automatic configuration (#6928 )	2019-11-02 21:21:00 +00:00
qmk.css	Some more tweaks to make everything look nice	2018-05-07 23:42:41 -07:00
quantum_keycodes.md	Added check for event pressed to clear space cadet (#5839 )	2019-05-11 22:20:14 -07:00
README.md	[Docs] Encourage newbs to not download the repo as a zip (#7353 )	2019-11-14 11:37:18 -08:00
redirects.json	Configuration system for CLI (#6708 )	2019-09-22 13:25:33 -07:00
ref_functions.md	Additional changes for Layer State typedef compatibility (#5906 )	2019-08-21 17:07:49 -07:00
reference_configurator_support.md	Update reference_configurator_support.md	2019-05-31 11:54:01 -07:00
reference_glossary.md	Remove apostrophe from various abbreviations' plural forms (#7050 )	2019-10-22 13:47:43 +01:00
reference_info_json.md	Add label to the info.json reference	2019-02-08 15:13:20 -08:00
sidebar.css	override hamburger placement	2018-05-14 08:56:41 -07:00
support.md	Add support for PR and Issue templates to QMK_firmware GitHub (#4494 )	2018-12-07 16:51:27 -08:00
sw.js	Fix up info boxes.	2018-05-07 22:46:26 -07:00
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	Remove apostrophe from various abbreviations' plural forms (#7050 )	2019-10-22 13:47:43 +01:00
unit_testing.md	Trim trailing whitespace	2017-12-09 10:46:11 -05:00
usb_nkro.txt	convert docs to lowercase and underscores	2017-06-10 14:58:55 -04:00
ws2812_driver.md	ARM - ws2812 bitbang (#7173 )	2019-11-07 13:10:29 +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.