Private Fork of the QMK keyboard firmware project with my own layout.
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.
 
 
 
 
 
Drashna Jaelre 6b5e349d7e
Add additional info to PR Checklist (#12630)
1 year ago
..
ChangeLog 2021 February 27 Breaking Changes Changelog (#11975) 1 year ago
de [Docs] Use HTTPS for images and links where possible (#11695) 1 year ago
es [Docs] Use HTTPS for images and links where possible (#11695) 1 year ago
fr-fr [Docs] Use HTTPS for images and links where possible (#11695) 1 year ago
gitbook/images RGB improvements (#1684) 5 years ago
he-il [Docs] Use HTTPS for images and links where possible (#11695) 1 year ago
ja [Docs] Japanese translation of docs/keycodes.md (#10192) 1 year ago
ko-kr [Docs] Use HTTPS for images and links where possible (#11695) 1 year ago
pt-br [Docs] Use HTTPS for images and links where possible (#11695) 1 year ago
ru-ru [Docs] Use HTTPS for images and links where possible (#11695) 1 year ago
zh-cn [Docs] Use HTTPS for images and links where possible (#11695) 1 year ago
.nojekyll Use docsfy to replace gitbook 4 years ago
CNAME Create CNAME 4 years ago
README.md Small tweaks to docs to make them more user friendly (#11518) 1 year ago
_langs.md [Docs] add README translation in portuguese (#7016) 2 years ago
_summary.md Add support for tab completion (#12411) 1 year ago
adc_driver.md Change analogRead calls to analogReadPin (#9023) 2 years ago
api_development_environment.md Add API documentation 2 years ago
api_development_overview.md Add API documentation 2 years ago
api_docs.md [Docs] Use HTTPS for images and links where possible (#11695) 1 year ago
api_overview.md [Docs] Use HTTPS for images and links where possible (#11695) 1 year ago
arm_debugging.md [Docs] fix docs (#7642) 2 years ago
audio_driver.md Audio system overhaul (#11820) 1 year ago
breaking_changes.md Fix Breaking Change date (#12272) 1 year ago
breaking_changes_history.md 2021 February 27 Breaking Changes Changelog (#11975) 1 year ago
breaking_changes_instructions.md 2020 May 30 Breaking Changes Update (#9215) 2 years ago
cli.md Streamline the macos install process 2 years ago
cli_commands.md Add a `qmk format-json` command that will format JSON files (#12372) 1 year ago
cli_configuration.md Fix capitalisation of "GitHub" (#9184) 2 years ago
cli_development.md Fix capitalisation of "GitHub" (#9184) 2 years ago
cli_tab_complete.md Add support for tab completion (#12411) 1 year ago
coding_conventions_c.md [Docs] Use HTTPS for images and links where possible (#11695) 1 year ago
coding_conventions_python.md Move everything to Python 3.6 (#8835) 2 years ago
compatible_microcontrollers.md Add STM32G431 and STM32G474 board definitions. (#11793) 1 year ago
config_options.md Audio system overhaul (#11820) 1 year ago
configurator_default_keymaps.md [Docs] add "Adding Default Keymaps to QMK Configurator" doc (#10049) 2 years ago
configurator_step_by_step.md Fix capitalisation of "GitHub" (#9184) 2 years ago
configurator_troubleshooting.md Polish Configurator section 2 years ago
contributing.md [Docs] Use HTTPS for images and links where possible (#11695) 1 year ago
custom_matrix.md Add docs for 'CUSTOM_MATRIX = lite' (#7906) 2 years ago
custom_quantum_functions.md 2020 November 28 Breaking Changes Update (#11053) 2 years ago
data_driven_config.md Create a system to map between info.json and config.h/rules.mk (#11548) 1 year ago
documentation_best_practices.md [Docs] fix file path (#9540) 2 years ago
documentation_templates.md [Docs] Use HTTPS for images and links where possible (#11695) 1 year ago
driver_installation_zadig.md Zadig docs: add APM32 device name (#11356) 1 year ago
eeprom_driver.md Add i2c 24LC64 eeprom (#11200) 1 year ago
faq_build.md [Docs] Use HTTPS for images and links where possible (#11695) 1 year ago
faq_debug.md Documentation changes SPLIT_USB_DETECT and hid_listen udev rules (#11665) 1 year ago
faq_general.md Fix typos and reword some sentences in FAQs (#11546) 1 year ago
faq_keymap.md [Docs] Use HTTPS for images and links where possible (#11695) 1 year ago
faq_misc.md [Docs] Use HTTPS for images and links where possible (#11695) 1 year ago
feature_advanced_keycodes.md [Docs] New section to modifier docs: Checking Modifier State (#10550) 1 year ago
feature_audio.md A few small typo fixes in docs (#12524) 1 year ago
feature_auto_shift.md 2020 November 28 Breaking Changes Update (#11053) 2 years ago
feature_backlight.md A few small typo fixes in docs (#12524) 1 year ago
feature_bluetooth.md Add description in Bluetooth docs for requiring NKRO to be disabled (#10359) 2 years ago
feature_bootmagic.md Add support for Bootmagic lite when using SPLIT_HAND_PIN (#8347) 2 years ago
feature_combo.md changed type of process_combo_event argument in tutorial (#10621) 2 years ago
feature_command.md Update IS_COMMAND definitions to use MOD_MASK_SHIFT (#6348) 3 years ago
feature_debounce_type.md Ensure single newline at EOF for core files (#11310) 1 year ago
feature_dip_switch.md add DIP_SWITCH_MATRIX_GRID support (#8772) 2 years ago
feature_dynamic_macros.md Fix typo in docs/feature_dynamic_macros (#10085) 2 years ago
feature_encoders.md 2020 November 28 Breaking Changes Update (#11053) 2 years ago
feature_grave_esc.md Document an annoyance with Grave Escape and macOS Terminal (#5483) 3 years ago
feature_haptic_feedback.md [Docs] Update feature_haptic_feedback.md (#11859) 1 year ago
feature_hd44780.md fixed typo for clear lcd screen function in hd44780 docs (#9086) 2 years ago
feature_joystick.md 2020 November 28 Breaking Changes Update (#11053) 2 years ago
feature_key_lock.md Add explicit id tags to externally linked headers 2 years ago
feature_layers.md Improve upon the 'Caveats' section of the Layers and Mod-Tap documentation (#12306) 1 year ago
feature_layouts.md Add a mechanism for force building a particular community layout (#5027) 3 years ago
feature_leader_key.md [Docs] Small spelling mistake fix in leader keys (#12087) 1 year ago
feature_led_indicators.md Indicator LEDs as config (#10816) 2 years ago
feature_led_matrix.md LED Matrix: rename `LED_DRIVER_LED_COUNT` to `DRIVER_LED_TOTAL` (#11858) 1 year ago
feature_macros.md [Docs] New section to modifier docs: Checking Modifier State (#10550) 1 year ago
feature_mouse_keys.md Add support for 8 buttons to mouse report (#10807) 1 year ago
feature_oled_driver.md 2020 November 28 Breaking Changes Update (#11053) 2 years ago
feature_pointing_device.md Merge remote-tracking branch 'origin/master' into develop 1 year ago
feature_ps2_mouse.md fix(feature_ps2_mouse): fix Scroll Button example (#11669) 1 year ago
feature_rawhid.md Updated Raw HID docs to clarify packet/report length (#11211) 1 year ago
feature_rgb_matrix.md 3 new LED effect animations (#9827) 1 year ago
feature_rgblight.md RGBLight: Allow configurable default settings (#11912) 1 year ago
feature_sequencer.md Ensure single newline at EOF for core files (#11310) 1 year ago
feature_space_cadet.md [Docs] Use HTTPS for images and links where possible (#11695) 1 year ago
feature_split_keyboard.md Documentation changes SPLIT_USB_DETECT and hid_listen udev rules (#11665) 1 year ago
feature_stenography.md [Docs] Use HTTPS for images and links where possible (#11695) 1 year ago
feature_swap_hands.md One shot support for swap hands (#8590) 2 years ago
feature_tap_dance.md More Tap Dance docs improvements (#12358) 1 year ago
feature_terminal.md Remove build option firmware size impacts (#6947) 3 years ago
feature_thermal_printer.md Format keycode tables 5 years ago
feature_unicode.md Add suggestion for indirect unicode input on Linux (#10854) 1 year ago
feature_userspace.md Normalise include statements in core code (#11153) 1 year ago
feature_velocikey.md Velocikey: Match RGB animation speed to typing speed (#3754) 3 years ago
feature_wpm.md Add Word Per Minute calculation feature (#8054) 2 years ago
flashing.md [Docs] Use HTTPS for images and links where possible (#11695) 1 year ago
flashing_bootloadhid.md Install bootloadHid as part of qmk_install (#7463) 3 years ago
fuse.txt Ensure single newline at EOF for core files (#11310) 1 year ago
getting_started_docker.md Add support for using podman to util/docker_build.sh (#10819) 1 year ago
getting_started_github.md [Docs] Use HTTPS for images and links where possible (#11695) 1 year ago
getting_started_introduction.md [Docs] update git command and directory name of documents (#7619) 2 years ago
getting_started_make_guide.md Documentation update (#12484) 1 year ago
getting_started_vagrant.md [Docs] Use HTTPS for images and links where possible (#11695) 1 year ago
hand_wire.md [Docs] Use HTTPS for images and links where possible (#11695) 1 year ago
hardware_avr.md [Docs] Use HTTPS for images and links where possible (#11695) 1 year ago
hardware_drivers.md Add customisable EEPROM driver selection (#7274) 2 years ago
hardware_keyboard_guidelines.md [Docs] Use HTTPS for images and links where possible (#11695) 1 year ago
how_a_matrix_works.md [Docs] Use HTTPS for images and links where possible (#11695) 1 year ago
how_keyboards_work.md Update URL for `60-keyboard.hwdb` (#7185) 3 years ago
i2c_driver.md Rework I2C driver docs (#11658) 1 year ago
index.html Simplify the visual flow of the getting started page (#11316) 1 year ago
internals_defines.md rename api docs to internals 4 years ago
internals_gpio_control.md [Docs] Use HTTPS for images and links where possible (#11695) 1 year ago
internals_input_callback_reg.md rename api docs to internals 4 years ago
internals_midi_device.md rename api docs to internals 4 years ago
internals_midi_device_setup_process.md rename api docs to internals 4 years ago
internals_midi_util.md rename api docs to internals 4 years ago
internals_send_functions.md rename api docs to internals 4 years ago
internals_sysex_tools.md rename api docs to internals 4 years ago
isp_flashing_guide.md [Docs] Update isp_flashing_guide.md (#11777) 1 year ago
keycodes.md [Docs] Use HTTPS for images and links where possible (#11695) 1 year ago
keycodes_basic.md Update keycode docs (#11343) 1 year ago
keycodes_us_ansi_shifted.md Backslash-escape pipe character in keycode lists (#7157) 3 years ago
keymap.md [Docs] Clarify layer transparency keymap.md (#9081) 2 years ago
mod_tap.md Improve upon the 'Caveats' section of the Layers and Mod-Tap documentation (#12306) 1 year ago
newbs.md [Docs] Use HTTPS for images and links where possible (#11695) 1 year ago
newbs_building_firmware.md Add explicit id tags to externally linked headers 2 years ago
newbs_building_firmware_configurator.md Small tweaks to docs to make them more user friendly (#11518) 1 year ago
newbs_flashing.md A few small typo fixes in docs (#12524) 1 year ago
newbs_getting_started.md Update github instruction link in newbs_getting_started.md (#12510) 1 year ago
newbs_git_best_practices.md [Docs] Restructure of Git Best Practices doc (#7231) 3 years ago
newbs_git_resolving_merge_conflicts.md [Docs] Restructure of Git Best Practices doc (#7231) 3 years ago
newbs_git_resynchronize_a_branch.md [Docs] Fix minor differences in docs/newbs_git_resynchronize_a_branch.md (#7728) 2 years ago
newbs_git_using_your_master_branch.md Add explicit id tags to externally linked headers 2 years ago
newbs_learn_more_resources.md Small tweaks to docs to make them more user friendly (#11518) 1 year ago
newbs_testing_debugging.md Small tweaks to docs to make them more user friendly (#11518) 1 year ago
one_shot_keys.md Update one_shot_keys.md (#10917) 2 years ago
other_eclipse.md eclipse: recommend changing the default project make target (#12447) 1 year ago
other_vscode.md Update other_vscode.md of Japanese document (#10604) 2 years ago
platformdev_chibios_earlyinit.md Ensure single newline at EOF for core files (#11310) 1 year ago
platformdev_selecting_arm_mcu.md Add documentation for selecting an Arm MCU (#9046) 2 years ago
power.txt Trim trailing whitespace 5 years ago
pr_checklist.md Add additional info to PR Checklist (#12630) 1 year ago
proton_c_conversion.md Add board specific to Proton-C, with usual defaults turned on. (#10976) 1 year ago
qmk.css Some more tweaks to make everything look nice 4 years ago
qmk_custom_dark.css Small tweaks to docs to make them more user friendly (#11518) 1 year ago
qmk_custom_light.css Small tweaks to docs to make them more user friendly (#11518) 1 year ago
quantum_keycodes.md Add explicit id tags to externally linked headers 2 years ago
redirects.json Configuration system for CLI (#6708) 3 years ago
ref_functions.md [Docs] Add EEP_RST keycode to "Wiping the EEPROM" section (#11830) 1 year ago
reference_configurator_support.md [Docs] Use HTTPS for images and links where possible (#11695) 1 year ago
reference_glossary.md [Docs] Use HTTPS for images and links where possible (#11695) 1 year ago
reference_info_json.md Merge remote-tracking branch 'origin/master' into develop 1 year ago
reference_keymap_extras.md Improved Language Specific Keycodes for US International and Extended Layouts (#11307) 1 year ago
serial_driver.md Configurable serial usart timeout (#11057) 1 year ago
spi_driver.md Merge remote-tracking branch 'upstream/master' into develop 1 year ago
support.md Fix capitalisation of "GitHub" (#9184) 2 years ago
sw.js Fix up info boxes. 4 years ago
syllabus.md [Docs] Fixed minor typos (#8860) 2 years ago
tap_hold.md Update IGNORE_MOD_TAP_INTERRUPT (#11452) 1 year ago
translating.md Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) 3 years ago
uart_driver.md UART driver refactor (#11637) 1 year ago
understanding_qmk.md Split transport mirror (#11046) 1 year ago
unit_testing.md [Docs] Use HTTPS for images and links where possible (#11695) 1 year ago
usb_nkro.txt convert docs to lowercase and underscores 5 years ago
ws2812_driver.md Add BGR byte order for WS2812 drivers (#11562) 1 year ago

README.md

Quantum Mechanical Keyboard Firmware

What is QMK Firmware?

QMK (Quantum Mechanical Keyboard) is an open source community centered around developing computer input devices. The community encompasses all sorts of input devices, such as keyboards, mice, and MIDI devices. A core group of collaborators maintains QMK Firmware, QMK Configurator, QMK Toolbox, qmk.fm, and this documentation with the help of community members like you.

Get Started

?> Basic QMK Configurator
User friendly graphical interfaces, no programming knowledge required.

?> Advanced Use The Source
More powerful, but harder to use.

Make It Yours

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.

Need help?

Check out the support page to see how you can get help using QMK.

Give Back

There are a lot of ways you can contribute to the QMK Community. The easiest way to get started is to use it and spread the word to your friends.