History

Joel Challis 51bcadf38c Add 'bootloadHID' flash target (#5587 ) * Add 'bootloadHID' flash target * Prep for flash target * Add :flash support * Align bootloader wait messages Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update template to suggest use of :flash		2019-08-24 08:35:11 -07:00
..
gitbook/images
zh
zh-cn	Remove superfluous JTAG disable code (#6445 )	2019-08-20 22:18:52 -07:00
_summary.md	Add Zadig 101 to docs (#6585 )	2019-08-23 23:38:21 -07:00
.nojekyll
arm_debugging.md
becoming_a_qmk_collaborator.md
cli.md	QMK CLI and JSON keymap support (#6176 )	2019-07-15 12:14:27 -07:00
CNAME
coding_conventions_c.md	QMK CLI and JSON keymap support (#6176 )	2019-07-15 12:14:27 -07:00
coding_conventions_python.md	QMK CLI and JSON keymap support (#6176 )	2019-07-15 12:14:27 -07:00
compatible_microcontrollers.md
config_options.md	Improve backlight PWM pin support (#6202 )	2019-08-08 13:12:12 -07:00
contributing.md	QMK CLI and JSON keymap support (#6176 )	2019-07-15 12:14:27 -07:00
custom_quantum_functions.md	Additional changes for Layer State typedef compatibility (#5906 )	2019-08-21 17:07:49 -07:00
documentation_best_practices.md
documentation_templates.md
driver_installation_zadig.md	Add Zadig 101 to docs (#6585 )	2019-08-23 23:38:21 -07:00
faq_build.md	Add Zadig 101 to docs (#6585 )	2019-08-23 23:38:21 -07:00
faq_debug.md	Remove superfluous JTAG disable code (#6445 )	2019-08-20 22:18:52 -07:00
faq_general.md
faq_keymap.md	Replace instances of KEYMAP with LAYOUT	2019-02-21 23:19:26 -08:00
faq.md
feature_advanced_keycodes.md	fix typo	2019-07-01 15:32:59 +09: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
feature_backlight.md	Improve backlight PWM pin support (#6202 )	2019-08-08 13:12:12 -07:00
feature_bluetooth.md
feature_bootmagic.md	Added keycodes for swapping and unswapping the Control and OS keys (#6110 )	2019-08-21 17:07:08 -07: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	Eager Per Row Debouncing added (added to Ergodox) (#5498 )	2019-04-03 14:45:55 -07:00
feature_dynamic_macros.md
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	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	Additional changes for Layer State typedef compatibility (#5906 )	2019-08-21 17:07:49 -07:00
feature_pointing_device.md
feature_ps2_mouse.md
feature_rgb_matrix.md	[Docs] Add RGB Matrix default mode define info (#6564 )	2019-08-19 15:03:05 -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 mod carry over from press to release. (#5866 )	2019-07-06 21:00:05 -07:00
feature_split_keyboard.md	Add support for different encoder pinout for right half of split keyboard (#6521 )	2019-08-16 16:46:41 -07:00
feature_stenography.md
feature_swap_hands.md
feature_tap_dance.md	[Docs] Add Sections and MO(layer)/TG(layer) Example (#6308 )	2019-07-25 11:53:19 -07:00
feature_terminal.md
feature_thermal_printer.md
feature_unicode.md	[Docs] Clarify the rules.mk setup for Unicode (#6286 )	2019-07-11 11:33:55 -07:00
feature_userspace.md	Additional changes for Layer State typedef compatibility (#5906 )	2019-08-21 17:07:49 -07:00
feature_velocikey.md	Velocikey: Match RGB animation speed to typing speed (#3754 )	2019-02-21 07:22:46 -08:00
features.md	[Docs] Add dedicated page for Split Keyboard information (#5802 )	2019-07-15 23:23:32 -07:00
flashing_bootloadhid.md	Add 'bootloadHID' flash target (#5587 )	2019-08-24 08:35:11 -07:00
flashing.md	Add 'bootloadHID' flash target (#5587 )	2019-08-24 08:35:11 -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	Add 'bootloadHID' flash target (#5587 )	2019-08-24 08:35:11 -07:00
getting_started_vagrant.md	Configure Vagrant to use qmk_base_container (#6194 )	2019-07-16 01:20:34 -07:00
hand_wire.md	A better new_project.sh (#5191 )	2019-04-27 16:42:16 -07:00
hardware_avr.md	Reword a note about the MANUFACTURER and PRODUCT defines in hardware_avr.md (#6558 )	2019-08-17 11:41:55 -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
hardware.md
how_keyboards_work.md	[Docs] Update how_keyboards_work.md (#6528 )	2019-08-21 17:44:37 -07:00
i2c_driver.md	Add ARM I2Cv1 support to i2c_master (#6262 )	2019-07-16 01:30:53 -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	Grammatical fixes for GPIO Control doc (#4869 )	2019-01-17 22:13:09 -08:00
internals_input_callback_reg.md
internals_midi_device_setup_process.md
internals_midi_device.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_basic.md	Add new brightness aliases to keycodes_basic.md	2019-01-17 18:35:45 -08:00
keycodes_us_ansi_shifted.md
keycodes.md	Added keycodes for swapping and unswapping the Control and OS keys (#6110 )	2019-08-21 17:07:08 -07:00
keymap.md	[Docs] Smallish overhaul of the docs (#5281 )	2019-03-18 14:22:02 -07:00
LANGS.md
newbs_best_practices.md
newbs_building_firmware_configurator.md	Update YouTube URL	2019-07-29 10:12:22 -07:00
newbs_building_firmware.md
newbs_flashing.md	Add 'bootloadHID' flash target (#5587 )	2019-08-24 08:35:11 -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
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
proton_c_conversion.md
python_development.md	QMK CLI and JSON keymap support (#6176 )	2019-07-15 12:14:27 -07:00
qmk.css
quantum_keycodes.md	Added check for event pressed to clear space cadet (#5839 )	2019-05-11 22:20:14 -07:00
README.md
redirects.json
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
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

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.