History

Rob Haswell cf30c5d17f RGB matrix effect - left-right gradient (#7742 ) * Left-right gradient. * Update the comment to match the new functionality. * CPP does integer division so this round is not necessary. * The x-range is actually 224, update comment and use bit-shifting again. * Update docs with gradient left-right effect and associated "DISABLE" option.		2020-01-07 21:25:17 +00: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	[Docs] fix docs (#7642 )	2019-12-21 11:00:22 +00:00
ja	[Docs] Update check commands in Japanese documents (#7787 )	2020-01-05 23:43:11 -08: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 for 2020-02-29 merge	2020-01-04 12:24:51 -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	Minor grammar and filename fixes in docs (#7559 )	2019-12-07 23:19:18 +11:00
compatible_microcontrollers.md	…
config_options.md	[Docs] Added description of LIB_SRC to docs/config_options.md (#7765 )	2020-01-02 14:47:27 -08:00
contributing.md	Improve docs "Edit Document" footer	2019-12-18 14:01:13 +11: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	…
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	fix instructions for oneshot layer handling on key release (#7554 )	2019-12-08 02:18:05 +00:00
feature_audio.md	…
feature_auto_shift.md	…
feature_backlight.md	Convert backlight to follow driver rules pattern - update docs	2019-12-14 03:25:06 +00:00
feature_bluetooth.md	…
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	…
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	Remove build option firmware size impacts (#6947 )	2019-10-18 18:14:49 -07:00
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	…
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	…
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	Add Dip Switch as a core feature (#6140 )	2019-09-03 08:34:31 -07:00
flashing.md	…
flashing_bootloadhid.md	Install bootloadHid as part of qmk_install (#7463 )	2019-11-28 15:29:11 +00:00
fuse.txt	convert docs to lowercase and underscores	2017-06-10 14:58:24 -04:00
getting_started_build_tools.md	[Docs] fix installation commands for macos (#7785 )	2020-01-03 22:57:59 -08: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	…
hand_wire.md	[Docs] Fixed internal links on Handwire page (#7154 )	2019-10-25 18:16:17 -07:00
hardware.md	…
hardware_avr.md	…
hardware_drivers.md	…
hardware_keyboard_guidelines.md	…
how_keyboards_work.md	Update URL for `60-keyboard.hwdb` (#7185 )	2019-10-28 02:41:22 +00:00
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	Add short aliases for Magic keycodes (#7541 )	2019-12-05 00:44:39 -08:00
keycodes_basic.md	…
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	…
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	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	…
other_eclipse.md	…
other_vscode.md	…
porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md	…
power.txt	Trim trailing whitespace	2017-12-09 10:46:11 -05:00
proton_c_conversion.md	Update feature support for Proton C (#7596 )	2019-12-10 18:31:39 -05:00
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	…
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	Add support for PR and Issue templates to QMK_firmware GitHub (#4494 )	2018-12-07 16:51:27 -08:00
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	convert docs to lowercase and underscores	2017-06-10 14:58:55 -04:00
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.