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
Drashna Jaelre 43757cd985
Cleanup learning newb links
6 years ago
..
gitbook/images RGB improvements (#1684) 7 years ago
.nojekyll Use docsfy to replace gitbook 7 years ago
CNAME Create CNAME 7 years ago
README.md Fix readme and contributing hyperlinks 7 years ago
_sidebar.md Cleanup learning newb links 6 years ago
_summary.md ARM SWD guide 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 Update Bluetooth docs (#4062) 6 years ago
contributing.md Update Contrib doc (#4068) 6 years ago
custom_quantum_functions.md Add C hint to inline code 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 Instruct macos users to use avr-gcc@7 (#3337) 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 Docs: Update image in FAQ/Keymap: KC_EQLS -> KC_EQL (#3660) 6 years ago
feature_advanced_keycodes.md Specify max layers supported in layer keycodes 6 years ago
feature_audio.md Add On/Off keycodes 6 years ago
feature_auto_shift.md Fix up info boxes. 7 years ago
feature_backlight.md Helpful functions 6 years ago
feature_bluetooth.md Update Bluetooth docs (#4062) 6 years ago
feature_bootmagic.md Create AG_TOGG code to toggle Alt/Gui swap. 6 years ago
feature_command.md Docs: Fix Command docs escaping (#3523) 6 years ago
feature_dynamic_macros.md Docs: Adjust dynamic macro docs to include more than the planck (#3509) 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 Docs: Add docs for the `LAYOUT_*` macro to layouts (#3772) 6 years ago
feature_leader_key.md Fix LEADER_KEY docs. 6 years ago
feature_macros.md Add tap_code function (#3784) 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 Make digital rain RGB matrix effect #define configurable. 6 years ago
feature_rgblight.md rgblight.[ch] more configurable (#3582) 6 years ago
feature_space_cadet_shift.md Docs: Format Space Cadet documentation (#3540) 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 Docs: Fix some minor errors in tap dance example (#3530) 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 Fix formatting in Unicode text 6 years ago
feature_userspace.md Spell-check update for Userspace documentation 6 years ago
features.md Dedupe shifted keycodes listing 6 years ago
flashing.md Correct small typo 6 years ago
fuse.txt convert docs to lowercase and underscores 8 years ago
getting_started_build_tools.md Instruct macos users to use avr-gcc@7 (#3337) 6 years ago
getting_started_getting_help.md Replace gitter links with Discord. (#3368) 6 years ago
getting_started_github.md Docs: Adjust prompt to be more recognizable (#3417) 6 years ago
getting_started_introduction.md Update config.h boilerplate to use `#pragma once` 6 years ago
getting_started_make_guide.md Lets split eh (#3120) 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 and cleanup AVR Hardware docs 6 years ago
hardware_drivers.md ISSI31FL3733 driver (#3679) 6 years ago
hardware_keyboard_guidelines.md Remove bootloader key as it is no longer used (#3093) 7 years ago
how_keyboards_work.md Convert all headings to Title Case 7 years ago
index.html override hamburger placement 7 years ago
internals_defines.md rename api docs to internals 7 years ago
internals_gpio_control.md Update quantum matrix to support both AVR and Chibios ARM (#3968) 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 Update ISP flashing guide with pre-compiled binary (#3217) 6 years ago
keycode.txt Trim trailing whitespace 7 years ago
keycodes.md Create AG_TOGG code to toggle Alt/Gui swap. 6 years ago
keycodes_basic.md More improvements to keycode docs (#3567) 6 years ago
keycodes_us_ansi_shifted.md Update Shifted keycodes docs (#3575) 6 years ago
keymap.md Remove redefinition of `_______` in documentation example (#3924) 6 years ago
newbs.md Cleanup learning newb links 6 years ago
newbs_building_firmware.md Add an easy way to create new keymaps for your favorite keyboard (#3868) 6 years ago
newbs_flashing.md Fix up info boxes. 7 years ago
newbs_getting_started.md added some helpful notes to the documentation (#2981) 7 years ago
newbs_learn_more_resources.md Cleanup learning newb links 6 years ago
newbs_testing_debugging.md Add a newbie guide for people completely new to QMK (#2480) 7 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
qmk.css Some more tweaks to make everything look nice 7 years ago
quantum_keycodes.md Trim trailing whitespace 7 years ago
redirects.json Docs: Format Space Cadet documentation (#3540) 6 years ago
ref_functions.md Helpful functions 6 years ago
reference_glossary.md Docs: Format Space Cadet documentation (#3540) 6 years ago
sidebar.css override hamburger placement 7 years ago
sw.js Fix up info boxes. 7 years ago
understanding_qmk.md Make `PREVENT_STUCK_MODIFIERS` the default (#3107) 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.