You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
qmk_firmware/docs
Konstantin Đorđević cd369b7107
docker_build.sh: Run container in interactive mode (#5088)
6 years ago
..
gitbook/images RGB improvements (#1684) 7 years ago
zh Adds Proton C Conversion (#4661) 6 years ago
.nojekyll Use docsfy to replace gitbook 7 years ago
CNAME Create CNAME 7 years ago
LANGS.md Second try at configuring i18n for docsify and gitbook (#4531) 6 years ago
README.md Fix readme and contributing hyperlinks 7 years ago
_summary.md Address comments in #4832. Move info.json reference to its own file. 6 years ago
arm_debugging.md ARM SWD guide 6 years ago
becoming_a_qmk_collaborator.md Tweak the wording in "Becoming a QMK Collaborator" 6 years ago
compatible_microcontrollers.md Convert all headings to Title Case 7 years ago
config_options.md Fix Command feature: use get_mods() instead of keyboard_report->mods (#4955) 6 years ago
contributing.md Update Contrib doc (#4068) 6 years ago
custom_quantum_functions.md Add kb and user level keyboard initialization functions (#3113) 6 years ago
documentation_best_practices.md Fix up info boxes. 7 years ago
documentation_templates.md Update Document Templates to reflect newer wording and URLs (#4006) 6 years ago
eclipse.md Fixed typo of 'confid.h' to 'config.h' (#2448) 7 years ago
faq.md Overhaul the Getting Started section and add a FAQ section 7 years ago
faq_build.md faq_build.md: Add section about serial devices on Linux 6 years ago
faq_debug.md Trim trailing whitespace 7 years ago
faq_general.md Convert all headings to Title Case 7 years ago
faq_keymap.md Add tap_random_base64 and software timer info to Useful Functions doc (#4360) 6 years ago
feature_advanced_keycodes.md Adds a period to the docs. 6 years ago
feature_audio.md Docs: Clarify audio keycodes (#4620) 6 years ago
feature_auto_shift.md Fix up info boxes. 7 years ago
feature_backlight.md Backlight - New option : BACKLIGHT_CAPS_LOCK (#4769) 6 years ago
feature_bluetooth.md Update Bluetooth docs (#4062) 6 years ago
feature_bootmagic.md [Docs] Bootmagic Lite Caveat (#5069) 6 years ago
feature_combo.md added missing ; on example (#5089) 6 years ago
feature_command.md Fix Command feature: use get_mods() instead of keyboard_report->mods (#4955) 6 years ago
feature_debounce_type.md Stricter, leaner DEBOUNCE_TYPE section in common_features.mk. Cleanup debounce_type.mk 6 years ago
feature_dynamic_macros.md Docs: Adjust dynamic macro docs to include more than the planck (#3509) 6 years ago
feature_encoders.md Improve Encoder documentation (#5130) 6 years ago
feature_grave_esc.md Docs: Format Grave Escape documentation (#3536) 6 years ago
feature_hd44780.md Integrating Peter Fleury's HD44780 LCD library (#3209) 6 years ago
feature_key_lock.md Docs: Format Key Lock documentation (#3538) 6 years ago
feature_layouts.md Add a mechanism for force building a particular community layout (#5027) 6 years ago
feature_leader_key.md Fix up process_leader to be a bit more optimized (#4662) 6 years ago
feature_led_matrix.md Add documentation for led matrix 6 years ago
feature_macros.md Fix up tap_code functionality (#4609) 6 years ago
feature_mouse_keys.md Fixed dead links (#2451) 7 years ago
feature_pointing_device.md Fix some of the more obvious typos 7 years ago
feature_ps2_mouse.md Circuitry sample for PS/2 Mouse (#3959) 6 years ago
feature_rgb_matrix.md Add documentation for led matrix 6 years ago
feature_rgblight.md Added noeeprom versions of set hue, sat, val, and step 6 years ago
feature_space_cadet_shift.md Improvements to Space Cadet Shift (#3856) 6 years ago
feature_space_cadet_shift_enter.md Docs: Format Space Cadet documentation (#3540) 6 years ago
feature_stenography.md Improve state/chord handling and clean up namespace 7 years ago
feature_swap_hands.md fix swap_hands keycodes in documentation (#3588) 6 years ago
feature_tap_dance.md Remove userspace info from Quad-Function Tap Dance example (#4631) 6 years ago
feature_terminal.md Added command history to terminal with other bug fixes, added new song to song_list.h (#2855) 7 years ago
feature_thermal_printer.md Format keycode tables 7 years ago
feature_unicode.md Improve consistency in UNICODEMAP code and docs, update docs/understanding_qmk (#4774) 6 years ago
feature_userspace.md Spell-check update for Userspace documentation 6 years ago
features.md Fix Encoder documentation (#4861) 6 years ago
flashing.md Instructions on how to flash via STM32 bootloader (#4316) 6 years ago
fuse.txt convert docs to lowercase and underscores 8 years ago
getting_started_build_tools.md docker_build.sh: Run container in interactive mode (#5088) 6 years ago
getting_started_getting_help.md Replace gitter links with Discord. (#3368) 6 years ago
getting_started_github.md Fix doc typo 6 years ago
getting_started_introduction.md Update config.h boilerplate to use `#pragma once` 6 years ago
getting_started_make_guide.md Simplify split_common Code significantly (#4772) 6 years ago
getting_started_vagrant.md Fix some of the more obvious typos 7 years ago
hand_wire.md Trim trailing whitespace 7 years ago
hardware.md Fix some of the more obvious typos 7 years ago
hardware_avr.md Update hardware config warnings to be more accurate 6 years ago
hardware_drivers.md ISSI31FL3733 driver (#3679) 6 years ago
hardware_keyboard_guidelines.md Clarify LAYOUT vs LAYOUT_all 6 years ago
how_keyboards_work.md Fix grammar, typos, and the link to HID specification 6 years ago
i2c_driver.md Add documentation for led matrix 6 years ago
index.html Adds Proton C Conversion (#4661) 6 years ago
internals_defines.md rename api docs to internals 7 years ago
internals_gpio_control.md Grammatical fixes for GPIO Control doc (#4869) 6 years ago
internals_input_callback_reg.md rename api docs to internals 7 years ago
internals_midi_device.md rename api docs to internals 7 years ago
internals_midi_device_setup_process.md rename api docs to internals 7 years ago
internals_midi_util.md rename api docs to internals 7 years ago
internals_send_functions.md rename api docs to internals 7 years ago
internals_sysex_tools.md rename api docs to internals 7 years ago
isp_flashing_guide.md Fix a typo in link to the Pro Micro ISP firmware 6 years ago
keycodes.md Add C(), A() and G() to match already existing S() (#4673) 6 years ago
keycodes_basic.md Add new brightness aliases to keycodes_basic.md 6 years ago
keycodes_us_ansi_shifted.md Add caveats for shifted characters (#4192) 6 years ago
keymap.md Remove redefinition of `_______` in documentation example (#3924) 6 years ago
newbs.md Contribute the MechMerlin QMK Configurator docs (#4986) 6 years ago
newbs_best_practices.md Docs: Adding QMK Git Conventions doc; formatting cleanup on Learning Resources doc (#3902) 6 years ago
newbs_building_firmware.md Fix syntax for windows 6 years ago
newbs_building_firmware_configurator.md Contribute the MechMerlin QMK Configurator docs (#4986) 6 years ago
newbs_flashing.md Fix up info boxes. 7 years ago
newbs_getting_started.md Contribute the MechMerlin QMK Configurator docs (#4986) 6 years ago
newbs_learn_more_resources.md Docs: Adding QMK Git Conventions doc; formatting cleanup on Learning Resources doc (#3902) 6 years ago
newbs_testing_debugging.md Fixed docs/newbs_testing_debugging.md and tmk_core/common/print.h 6 years ago
porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md Fix some of the more obvious typos 7 years ago
power.txt Trim trailing whitespace 7 years ago
proton_c_conversion.md Adds Proton C Conversion (#4661) 6 years ago
qmk.css Some more tweaks to make everything look nice 7 years ago
quantum_keycodes.md Add EEPROM_RESET keycode to core code (#4234) 6 years ago
redirects.json Docs: Format Space Cadet documentation (#3540) 6 years ago
ref_functions.md Add tap_random_base64 and software timer info to Useful Functions doc (#4360) 6 years ago
reference_configurator_support.md Docs: Supporting a keyboard in the QMK Configurator (#4396) 6 years ago
reference_glossary.md Fix more broken links to the HID spec 6 years ago
reference_info_json.md Add label to the info.json reference 6 years ago
sidebar.css override hamburger placement 7 years ago
support.md Add support for PR and Issue templates to QMK_firmware GitHub (#4494) 6 years ago
sw.js Fix up info boxes. 7 years ago
understanding_qmk.md Improve consistency in UNICODEMAP code and docs, update docs/understanding_qmk (#4774) 6 years ago
unit_testing.md Trim trailing whitespace 7 years ago
usb_nkro.txt convert docs to lowercase and underscores 8 years ago

README.md

Quantum Mechanical Keyboard Firmware

Current Version Build Status Discord Docs Status GitHub contributors GitHub forks

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.