_/qmk_firmware
1
0
Fork 0
Code Releases Activity
qmk_firmware/docs
History
Andrew Macpherson d0054c41e2 Fix typo in autoshift docs: statn (#2579)
2018-03-23 16:03:19 -07:00
..
gitbook/images RGB improvements (#1684) 2017-09-06 14:49:19 -07:00
_summary.md Generate API docs from source code comments (#2491) 2018-03-22 02:50:38 -04:00
api_defines.md Generate API docs from source code comments (#2491) 2018-03-22 02:50:38 -04:00
api_input_callback_reg.md Generate API docs from source code comments (#2491) 2018-03-22 02:50:38 -04:00
api_midi_device.md Generate API docs from source code comments (#2491) 2018-03-22 02:50:38 -04:00
api_midi_device_setup_process.md Generate API docs from source code comments (#2491) 2018-03-22 02:50:38 -04:00
api_midi_util.md Generate API docs from source code comments (#2491) 2018-03-22 02:50:38 -04:00
api_send_functions.md Generate API docs from source code comments (#2491) 2018-03-22 02:50:38 -04:00
api_sysex_tools.md Generate API docs from source code comments (#2491) 2018-03-22 02:50:38 -04: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 Clarify that we actually have max 16 total backlight levels 2018-01-12 12:52:35 -05:00
contributing.md Trim trailing whitespace 2017-12-09 10:46:11 -05:00
custom_quantum_functions.md Add layer_state_set_* to custom function lists 2018-03-07 17:05:38 -05:00
documentation_best_practices.md Fix some of the more obvious typos 2017-12-09 10:46:11 -05: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 Minor updates to docs (#2406) 2018-02-19 14:09:05 -05: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 Add macro for momentarily switching to a layer while some mods are active (#2460) 2018-03-20 22:59:54 -04:00
feature_audio.md Fixed typo of 'confid.h' to 'config.h' (#2448) 2018-02-28 16:43:15 -05:00
feature_auto_shift.md Fix typo in autoshift docs: statn (#2579) 2018-03-23 16:03:19 -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 More thoroughly document Bootmagic and Command (#2455) 2018-03-02 09:21:03 -08: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 Add SS_RALT for AltGR usage in macros 2018-03-09 13:15:10 -05: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_rgblight.md [Proposal?] Allow RGB Underglow to turn off when host is idle/asleep (#2104) 2018-03-19 23:59: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 Fix some of the more obvious typos 2017-12-09 10:46:11 -05:00
feature_swap_hands.md Add keycodes for swap-hands feature. 2018-03-16 16:33:43 -04:00
feature_tap_dance.md Trim trailing whitespace 2017-12-09 10:46:11 -05:00
feature_terminal.md Trim trailing whitespace 2017-12-09 10:46:11 -05: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 Trim trailing whitespace 2017-12-09 10:46:11 -05:00
features.md Fix some of the more obvious typos 2017-12-09 10:46:11 -05:00
flashing.md Trim trailing whitespace 2017-12-09 10:46:11 -05:00
fuse.txt convert docs to lowercase and underscores 2017-06-10 14:58:24 -04:00
getting_started_build_tools.md Fixed formatting for Fedora example 2018-02-23 13:13:30 -05: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 Convert all headings to Title Case 2017-12-09 10:46:11 -05:00
getting_started_introduction.md Convert all headings to Title Case 2017-12-09 10:46:11 -05:00
getting_started_make_guide.md Trim trailing whitespace 2017-12-09 10:46:11 -05: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 backlight breathing overhaul (#2187) 2018-01-01 17:47:51 -05:00
hardware_drivers.md Convert all headings to Title Case 2017-12-09 10:46:11 -05:00
hardware_keyboard_guidelines.md Added bootloader options 2018-03-20 11:47:22 -04:00
how_keyboards_work.md Convert all headings to Title Case 2017-12-09 10:46:11 -05: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 Add macro for momentarily switching to a layer while some mods are active (#2460) 2018-03-20 22:59:54 -04: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 Minor updates to docs (#2406) 2018-02-19 14:09:05 -05: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 warn->danger 2018-03-06 15:39:46 -08:00
newbs_flashing.md Add a newbie guide for people completely new to QMK (#2480) 2018-03-06 14:37:48 -08:00
newbs_getting_started.md Move the linux tutorials to an info box on newbs_getting_started 2018-03-06 20:51:26 -08: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
quantum_keycodes.md Trim trailing whitespace 2017-12-09 10:46:11 -05:00
README.md Convert all headings to Title Case 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
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 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.