History

noroadsleft 480651cf9d Docs: Adding QMK Git Conventions doc; formatting cleanup on Learning Resources doc (#3902 ) * Docs: newbs_learn_more_resources.md: formatting * Added QMK Git Conventions doc, initial version * Renamed contributing_qmk.md to newbs_best_practices.md * Updated per review by @drashna * Added navigation links * Updated to Best Practices doc * Minor updates to Learn More Resources doc Markdown formatting consistency because I'm particular about it. * Added Merge Conflict section to Best Practices doc		2018-10-18 15:12:11 -07:00
..
gitbook/images	RGB improvements (#1684 )	2017-09-06 14:49:19 -07:00
_sidebar.md	Docs: Adding QMK Git Conventions doc; formatting cleanup on Learning Resources doc (#3902 )	2018-10-18 15:12:11 -07:00
_summary.md	Docs: Adding QMK Git Conventions doc; formatting cleanup on Learning Resources doc (#3902 )	2018-10-18 15:12:11 -07:00
.nojekyll	Use docsfy to replace gitbook	2018-05-07 22:46:26 -07:00
arm_debugging.md	ARM SWD guide	2018-10-05 11:03:30 -07:00
becoming_a_qmk_collaborator.md	Tweak the wording in "Becoming a QMK Collaborator"	2018-08-30 07:39:58 -04:00
CNAME	Create CNAME	2018-05-21 16:29:37 -04:00
compatible_microcontrollers.md	Convert all headings to Title Case	2017-12-09 10:46:11 -05:00
config_options.md	Add documentation for Combo feature	2018-10-10 21:36:58 -04:00
contributing.md	Update Contrib doc (#4068 )	2018-10-06 20:43:37 -04:00
custom_quantum_functions.md	Fix Typo in Custom Quantum functions document (led_state) (#4129 )	2018-10-13 00:40:42 -07:00
documentation_best_practices.md	Fix up info boxes.	2018-05-07 22:46:26 -07:00
documentation_templates.md	Update Document Templates to reflect newer wording and URLs (#4006 )	2018-09-28 12:04:30 -04:00
eclipse.md	Fixed typo of 'confid.h' to 'config.h' (#2448 )	2018-02-28 16:43:15 -05:00
faq_build.md	Instruct macos users to use avr-gcc@7 (#3337 )	2018-07-07 17:37:37 -07:00
faq_debug.md	Trim trailing whitespace	2017-12-09 10:46:11 -05:00
faq_general.md	Convert all headings to Title Case	2017-12-09 10:46:11 -05:00
faq_keymap.md	Docs: Update image in FAQ/Keymap: KC_EQLS -> KC_EQL (#3660 )	2018-08-15 09:48:14 -07: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	Specify max layers supported in layer keycodes	2018-10-10 11:48:36 -04:00
feature_audio.md	Add On/Off keycodes	2018-09-25 13:28:36 -07:00
feature_auto_shift.md	Fix up info boxes.	2018-05-07 22:46:26 -07:00
feature_backlight.md	Helpful functions	2018-08-26 07:32:15 -07:00
feature_bluetooth.md	Update Bluetooth docs (#4062 )	2018-10-07 11:23:41 -07:00
feature_bootmagic.md	Create AG_TOGG code to toggle Alt/Gui swap.	2018-09-17 15:04:22 -07:00
feature_combo.md	Add documentation for Combo feature	2018-10-10 21:36:58 -04:00
feature_command.md	Docs: Fix Command docs escaping (#3523 )	2018-07-29 21:08:59 -07:00
feature_dynamic_macros.md	Docs: Adjust dynamic macro docs to include more than the planck (#3509 )	2018-07-29 08:59:39 -07:00
feature_grave_esc.md	Docs: Format Grave Escape documentation (#3536 )	2018-07-31 17:40:55 -07:00
feature_hd44780.md	Integrating Peter Fleury's HD44780 LCD library (#3209 )	2018-07-15 13:31:45 -04:00
feature_key_lock.md	Docs: Format Key Lock documentation (#3538 )	2018-07-31 18:07:50 -07:00
feature_layouts.md	Docs: Add docs for the `LAYOUT_*` macro to layouts (#3772 )	2018-08-28 17:35:24 -07:00
feature_leader_key.md	Fix LEADER_KEY docs.	2018-09-17 14:38:06 -07:00
feature_macros.md	Add tap_code function (#3784 )	2018-10-01 20:53:47 -04:00
feature_mouse_keys.md	Fixed dead links (#2451 )	2018-03-01 07:45: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	Circuitry sample for PS/2 Mouse (#3959 )	2018-09-23 13:49:17 -07:00
feature_rgb_matrix.md	Make digital rain RGB matrix effect #define configurable.	2018-10-01 12:54:37 -04:00
feature_rgblight.md	add a notice into docs/feature_rgblight.md	2018-10-11 17:14:42 -07:00
feature_space_cadet_shift_enter.md	Docs: Format Space Cadet documentation (#3540 )	2018-08-01 08:43:54 -07:00
feature_space_cadet_shift.md	Docs: Format Space Cadet documentation (#3540 )	2018-08-01 08:43:54 -07: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: Fix some minor errors in tap dance example (#3530 )	2018-07-31 17:50:02 -07:00
feature_terminal.md	Added command history to terminal with other bug fixes, added new song to song_list.h (#2855 )	2018-05-01 13:39:46 -04:00
feature_thermal_printer.md	Format keycode tables	2017-12-09 10:46:11 -05:00
feature_unicode.md	Fix formatting in Unicode text	2018-10-09 15:21:08 -04:00
feature_userspace.md	Spell-check update for Userspace documentation	2018-09-28 14:39:52 -04:00
features.md	Dedupe shifted keycodes listing	2018-08-11 14:29:53 -07:00
flashing.md	Correct small typo	2018-10-01 12:42:05 -04:00
fuse.txt	convert docs to lowercase and underscores	2017-06-10 14:58:24 -04:00
getting_started_build_tools.md	Instruct macos users to use avr-gcc@7 (#3337 )	2018-07-07 17:37:37 -07: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	Update config.h boilerplate to use `#pragma once`	2018-07-15 13:21:20 -04:00
getting_started_make_guide.md	Lets split eh (#3120 )	2018-07-16 22:25:02 -04:00
getting_started_vagrant.md	Fix some of the more obvious typos	2017-12-09 10:46:11 -05:00
hand_wire.md	Trim trailing whitespace	2017-12-09 10:46:11 -05:00
hardware_avr.md	Update and cleanup AVR Hardware docs	2018-10-10 21:35:26 -04:00
hardware_drivers.md	ISSI31FL3733 driver (#3679 )	2018-08-28 09:03:11 -04:00
hardware_keyboard_guidelines.md	Remove bootloader key as it is no longer used (#3093 )	2018-06-01 12:26:48 -07:00
hardware.md	Fix some of the more obvious typos	2017-12-09 10:46:11 -05:00
how_keyboards_work.md	Fix grammar, typos, and the link to HID specification	2018-10-17 16:51:51 -07:00
index.html	override hamburger placement	2018-05-14 08:56:41 -07:00
internals_defines.md	rename api docs to internals	2018-03-26 11:43:37 -07:00
internals_gpio_control.md	Update quantum matrix to support both AVR and Chibios ARM (#3968 )	2018-09-28 12:33:11 -04: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	Update ISP flashing guide with pre-compiled binary (#3217 )	2018-08-02 23:07:33 -04:00
keycode.txt	Trim trailing whitespace	2017-12-09 10:46:11 -05:00
keycodes_basic.md	Fix more broken links to the HID spec	2018-10-17 16:51:51 -07:00
keycodes_us_ansi_shifted.md	Update Shifted keycodes docs (#3575 )	2018-08-05 08:55:53 -07:00
keycodes.md	Create AG_TOGG code to toggle Alt/Gui swap.	2018-09-17 15:04:22 -07:00
keymap.md	Remove redefinition of `_______` in documentation example (#3924 )	2018-09-19 16:18:15 -07:00
newbs_best_practices.md	Docs: Adding QMK Git Conventions doc; formatting cleanup on Learning Resources doc (#3902 )	2018-10-18 15:12:11 -07:00
newbs_building_firmware.md	Add an easy way to create new keymaps for your favorite keyboard (#3868 )	2018-09-13 11:22:05 -07:00
newbs_flashing.md	Fix up info boxes.	2018-05-07 22:46:26 -07:00
newbs_getting_started.md	added some helpful notes to the documentation (#2981 )	2018-05-22 12:48:33 -07: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	Add a newbie guide for people completely new to QMK (#2480 )	2018-03-06 14:37:48 -08:00
newbs.md	Docs: Adding QMK Git Conventions doc; formatting cleanup on Learning Resources doc (#3902 )	2018-10-18 15:12:11 -07:00
porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md	Fix some of the more obvious typos	2017-12-09 10:46:11 -05:00
power.txt	Trim trailing whitespace	2017-12-09 10:46:11 -05:00
qmk.css	Some more tweaks to make everything look nice	2018-05-07 23:42:41 -07:00
quantum_keycodes.md	Trim trailing whitespace	2017-12-09 10:46:11 -05:00
README.md	Fix readme and contributing hyperlinks	2018-05-24 00:00:20 -04:00
redirects.json	Docs: Format Space Cadet documentation (#3540 )	2018-08-01 08:43:54 -07:00
ref_functions.md	Helpful functions	2018-08-26 07:32:15 -07:00
reference_glossary.md	Fix more broken links to the HID spec	2018-10-17 16:51:51 -07:00
sidebar.css	override hamburger placement	2018-05-14 08:56:41 -07:00
sw.js	Fix up info boxes.	2018-05-07 22:46:26 -07:00
understanding_qmk.md	Make `PREVENT_STUCK_MODIFIERS` the default (#3107 )	2018-09-17 13:48:02 -04: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

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.