History

yiancar 470c50ddb6 Update documentation for rgb matrix (#3023 ) * Update documentation for rgb matrix - Updated keycodes.md to include RGB matrix keycodes + necessary link		2018-05-22 14:18:40 -07:00
..
gitbook/images	RGB improvements (#1684 )	2017-09-06 14:49:19 -07:00
.nojekyll	Use docsfy to replace gitbook	2018-05-07 22:46:26 -07:00
CNAME	Create CNAME	2018-05-21 16:29:37 -04:00
README.md	update doc options	2018-05-09 00:59:07 -04:00
_sidebar.md	Make sure new features (RGB Matrix) are actually listed	2018-05-15 22:35:17 -04:00
_summary.md	rename api docs to internals	2018-03-26 11:43:37 -07:00
becoming_a_qmk_collaborator.md	Convert all headings to Title Case	2017-12-09 10:46:11 -05:00
compatible_microcontrollers.md	Convert all headings to Title Case	2017-12-09 10:46:11 -05:00
config_options.md	Add dilly/pletcher layout (#2880 )	2018-05-02 18:35:16 -07:00
contributing.md	Trim trailing whitespace	2017-12-09 10:46:11 -05:00
custom_quantum_functions.md	Fix custom functions documation for layer_state_set*	2018-03-24 12:49:56 -04:00
documentation_best_practices.md	Fix up info boxes.	2018-05-07 22:46:26 -07:00
documentation_templates.md	Make arguments redo, subproject elimination (#1784 )	2017-10-14 11:32:19 -10:00
eclipse.md	Fixed typo of 'confid.h' to 'config.h' (#2448 )	2018-02-28 16:43:15 -05:00
faq.md	Overhaul the Getting Started section and add a FAQ section	2017-08-16 15:47:20 -04:00
faq_build.md	Fixes and updates to docs (#2611 )	2018-03-25 16:44:17 -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	More thoroughly document Bootmagic and Command (#2455 )	2018-03-02 09:21:03 -08:00
feature_advanced_keycodes.md	Fix up info boxes.	2018-05-07 22:46:26 -07:00
feature_audio.md	updated music mask	2018-05-08 17:18:15 -04:00
feature_auto_shift.md	Fix up info boxes.	2018-05-07 22:46:26 -07:00
feature_backlight.md	Clarify that we actually have max 16 total backlight levels	2018-01-12 12:52:35 -05:00
feature_bluetooth.md	Format keycode tables	2017-12-09 10:46:11 -05:00
feature_bootmagic.md	Fix link to command page	2018-04-15 11:53:31 -04:00
feature_command.md	More thoroughly document Bootmagic and Command (#2455 )	2018-03-02 09:21:03 -08:00
feature_dynamic_macros.md	Trim trailing whitespace	2017-12-09 10:46:11 -05:00
feature_grave_esc.md	Format keycode tables	2017-12-09 10:46:11 -05:00
feature_key_lock.md	Convert all headings to Title Case	2017-12-09 10:46:11 -05:00
feature_layouts.md	Clarify the format for layout names	2018-01-19 11:58:19 -08:00
feature_leader_key.md	Convert all headings to Title Case	2017-12-09 10:46:11 -05:00
feature_macros.md	Fix up info boxes.	2018-05-07 22:46:26 -07: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	Trim trailing whitespace	2017-12-09 10:46:11 -05:00
feature_rgb_matrix.md	General RGB matrix fixes (#2931 )	2018-05-10 00:31:24 -04:00
feature_rgblight.md	Add rgblist to docs	2018-03-28 16:55:58 -04:00
feature_space_cadet.md	Fix some of the more obvious typos	2017-12-09 10:46:11 -05:00
feature_space_shift_cadet.md	new planck keymap, new feature - hybrid shift/enter action key (great for small keyboards!) (#2100 )	2017-12-14 00:20:44 -05:00
feature_stenography.md	Improve state/chord handling and clean up namespace	2018-04-07 17:12:44 -04:00
feature_swap_hands.md	Add keycodes for swap-hands feature.	2018-03-16 16:33:43 -04:00
feature_tap_dance.md	List all Tap Dancing functions (#2945 )	2018-05-14 10:17:50 -04: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 some of the more obvious typos	2017-12-09 10:46:11 -05:00
feature_userspace.md	Talljoe's layout with common keymap. (#2764 )	2018-04-21 10:48:30 -07:00
features.md	Make sure new features (RGB Matrix) are actually listed	2018-05-15 22:35:17 -04:00
flashing.md	Link to Atmel's flip is broken. (#2752 )	2018-04-18 22:21:36 -04:00
fuse.txt	convert docs to lowercase and underscores	2017-06-10 14:58:24 -04:00
getting_started_build_tools.md	added some helpful notes to the documentation (#2981 )	2018-05-22 12:48:33 -07:00
getting_started_getting_help.md	Add a newbie guide for people completely new to QMK (#2480 )	2018-03-06 14:37:48 -08:00
getting_started_github.md	Fix up info boxes.	2018-05-07 22:46:26 -07:00
getting_started_introduction.md	Convert all headings to Title Case	2017-12-09 10:46:11 -05:00
getting_started_make_guide.md	Added propper support for Lets split vitamins (#2559 )	2018-05-09 09:14:30 -07: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.md	Fix some of the more obvious typos	2017-12-09 10:46:11 -05:00
hardware_avr.md	Fix up info boxes.	2018-05-07 22:46:26 -07:00
hardware_drivers.md	Convert all headings to Title Case	2017-12-09 10:46:11 -05:00
hardware_keyboard_guidelines.md	Remove obsolete info.json entries (#2712 )	2018-04-07 17:37:31 -07:00
how_keyboards_work.md	Convert all headings to Title Case	2017-12-09 10:46:11 -05: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_input_callback_reg.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_device_setup_process.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	Trim trailing whitespace	2017-12-09 10:46:11 -05:00
keycode.txt	Trim trailing whitespace	2017-12-09 10:46:11 -05:00
keycodes.md	Update documentation for rgb matrix (#3023 )	2018-05-22 14:18:40 -07:00
keycodes_basic.md	Add CMD and WIN aliases for KC_GUI, GUI(kc), GUI_T(kc), etc.	2018-03-16 16:37:44 -04:00
keycodes_us_ansi_shifted.md	Trim trailing whitespace	2017-12-09 10:46:11 -05:00
keymap.md	Fixes and updates to docs (#2611 )	2018-03-25 16:44:17 -07:00
newbs.md	Move the linux tutorials to an info box on newbs_getting_started	2018-03-06 20:51:26 -08:00
newbs_building_firmware.md	Fix up info boxes.	2018-05-07 22:46:26 -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_testing_debugging.md	Add a newbie guide for people completely new to QMK (#2480 )	2018-03-06 14:37:48 -08: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
redirects.json	Disable the glossary linking to fix #2498 (#2499 )	2018-03-08 10:31:08 -08:00
reference_glossary.md	Disable the glossary linking to fix #2498 (#2499 )	2018-03-08 10:31:08 -08: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	Fixed dead links (#2451 )	2018-03-01 07:45:47 -08: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.