History

Jack Humbert 00733f4b87 update contributing guidelines		2017-11-01 21:42:05 -04:00
..
gitbook/images	RGB improvements (#1684 )	2017-09-06 14:49:19 -07:00
_summary.md	update hand wiring link	2017-10-31 13:38:57 -04:00
becoming_a_qmk_collaborator.md	convert docs to lowercase and underscores	2017-06-10 14:58:24 -04:00
compatible_microcontrollers.md	convert docs to lowercase and underscores	2017-06-10 14:58:24 -04:00
config_options.md	RETRO_TAPPING (#1922 )	2017-10-31 11:15:22 -04:00
contributing.md	update contributing guidelines	2017-11-01 21:42:05 -04:00
custom_quantum_functions.md	Fix minor formatting issue.	2017-07-23 15:10:27 -04:00
documentation_best_practices.md	Doc updates from going through every file	2017-08-16 15:47:20 -04:00
documentation_templates.md	Make arguments redo, subproject elimination (#1784 )	2017-10-14 11:32:19 -10:00
eclipse.md	Update a bunch of docs	2017-07-03 01:30:36 -07:00
faq_build.md	Fix code backticks on Frequently Asked Build Questions docs	2017-10-21 09:58:48 -10:00
faq_debug.md	Fixed typo in docs. (#1818 )	2017-10-06 20:15:55 -07:00
faq_general.md	Improvements to documentation (#1919 )	2017-11-01 11:21:54 -04:00
faq_keymap.md	Restructure the hardware and feature docs to make things easier to find (#1888 )	2017-10-24 20:34:28 -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	Restructure the hardware and feature docs to make things easier to find (#1888 )	2017-10-24 20:34:28 -07:00
feature_audio.md	Doc updates from going through every file	2017-08-16 15:47:20 -04:00
feature_auto_shift.md	Fix code example in auto shift docs	2017-10-29 20:04:10 -04:00
feature_backlight.md	break up keymaps and quantum keycodes into files by feature	2017-08-16 15:47:20 -04:00
feature_bluetooth.md	Doc updates from going through every file	2017-08-16 15:47:20 -04:00
feature_bootmagic.md	Edited a minor typo in feature_bootmagic.md.	2017-10-05 06:17:34 -10:00
feature_dynamic_macros.md	Restructure the hardware and feature docs to make things easier to find (#1888 )	2017-10-24 20:34:28 -07:00
feature_key_lock.md	Restructure the hardware and feature docs to make things easier to find (#1888 )	2017-10-24 20:34:28 -07:00
feature_layouts.md	Make arguments redo, subproject elimination (#1784 )	2017-10-14 11:32:19 -10:00
feature_leader_key.md	Doc updates from going through every file	2017-08-16 15:47:20 -04:00
feature_macros.md	Restructure the hardware and feature docs to make things easier to find (#1888 )	2017-10-24 20:34:28 -07:00
feature_mouse_keys.md	Restructure the hardware and feature docs to make things easier to find (#1888 )	2017-10-24 20:34:28 -07:00
feature_pointing_device.md	Generic Pointing Device (#1767 )	2017-10-06 07:13:08 -10:00
feature_ps2_mouse.md	Add option to reverse PS2 mouse axes and scrolling	2017-10-10 07:20:17 -10:00
feature_rgblight.md	Added a new keycode for cycling through RBG modes which reverses directions when shift is hold.	2017-10-24 17:02:20 -10:00
feature_space_cadet.md	Restructure the hardware and feature docs to make things easier to find (#1888 )	2017-10-24 20:34:28 -07:00
feature_stenography.md	Fixed various feature links	2017-10-29 20:04:10 -04:00
feature_tap_dance.md	fixed two typos	2017-10-31 00:40:27 -04:00
feature_terminal.md	Updates send_string functionality, adds terminal feature (#1657 )	2017-09-12 00:43:10 -04:00
feature_thermal_printer.md	break up keymaps and quantum keycodes into files by feature	2017-08-16 15:47:20 -04:00
feature_unicode.md	Restructure the hardware and feature docs to make things easier to find (#1888 )	2017-10-24 20:34:28 -07:00
feature_userspace.md	Creates a userspace for keymaps (#1559 )	2017-10-21 11:44:11 -10:00
features.md	Added missing RGB and Auto Shift in main feature list. Also standardized on period at the end of each feature list item.	2017-10-29 20:04:10 -04:00
flashing.md	adds flashing docs	2017-10-29 18:44:29 -04:00
fuse.txt	convert docs to lowercase and underscores	2017-06-10 14:58:24 -04:00
getting_started_build_tools.md	Improvements to documentation (#1919 )	2017-11-01 11:21:54 -04:00
getting_started_github.md	Update getting_started_github.md	2017-11-01 14:10:28 -04:00
getting_started_introduction.md	Improvements to documentation (#1919 )	2017-11-01 11:21:54 -04:00
getting_started_make_guide.md	Restructure the hardware and feature docs to make things easier to find (#1888 )	2017-10-24 20:34:28 -07:00
getting_started_vagrant.md	Overhaul the Getting Started section and add a FAQ section	2017-08-16 15:47:20 -04:00
glossary.md	Restructure the hardware and feature docs to make things easier to find (#1888 )	2017-10-24 20:34:28 -07:00
hand_wire.md	Make arguments redo, subproject elimination (#1784 )	2017-10-14 11:32:19 -10:00
hardware_avr.md	Restructure the hardware and feature docs to make things easier to find (#1888 )	2017-10-24 20:34:28 -07:00
hardware_drivers.md	Restructure the hardware and feature docs to make things easier to find (#1888 )	2017-10-24 20:34:28 -07:00
hardware_keyboard_guidelines.md	Restructure the hardware and feature docs to make things easier to find (#1888 )	2017-10-24 20:34:28 -07:00
hardware.md	Restructure the hardware and feature docs to make things easier to find (#1888 )	2017-10-24 20:34:28 -07:00
how_keyboards_work.md	Add link to keycodes doc in how_keyboards_work	2017-08-18 12:49:55 -04:00
isp_flashing_guide.md	update docs for isp	2017-06-23 23:09:14 -04:00
keycode.txt	Docfix (#1377 )	2017-06-08 20:05:55 -07:00
keycodes_basic.md	platform descriptions to match master keycodes.md documentation	2017-09-25 13:07:46 -04:00
keycodes_us_ansi_shifted.md	break up keymaps and quantum keycodes into files by feature	2017-08-16 15:47:20 -04:00
keycodes.md	Restructure the hardware and feature docs to make things easier to find (#1888 )	2017-10-24 20:34:28 -07:00
keymap.md	Broken link found in issue #1845	2017-10-15 15:03:23 -10:00
porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md	convert docs to lowercase and underscores	2017-06-10 14:58:55 -04:00
power.txt	convert docs to lowercase and underscores	2017-06-10 14:58:55 -04:00
quantum_keycodes.md	Restructure the hardware and feature docs to make things easier to find (#1888 )	2017-10-24 20:34:28 -07:00
README.md	Make arguments redo, subproject elimination (#1784 )	2017-10-14 11:32:19 -10:00
redirects.json	Restructure the hardware and feature docs to make things easier to find (#1888 )	2017-10-24 20:34:28 -07:00
understanding_qmk.md	Added Auto Shift, tap key = normal, hold key = shifted state.	2017-09-18 17:08:18 -04:00
unit_testing.md	Make arguments redo, subproject elimination (#1784 )	2017-10-14 11:32:19 -10: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 Flasher, 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.