hailey
/
qmk_firmware
mirror of https://github.com/hailey/qmk_firmware.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
My local repo of qmk firmware.
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.
13969 Commits
54 Branches
1475 Tags
301 MiB
 
 
 
 
Tag: Branch: Tree: cc4b93b330
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'cc4b93b330'
${ noResults }
qmk_firmware/docs
History
Nick Blyumberg b2ab0af905
[Docs] Update links in main README.md (#11284) 		4 years ago
..
ChangeLog 2020 November 28 Breaking Changes Update (#11053) 5 years ago
de Normalise include statements in core code (#11153) 4 years ago
es Normalise include statements in core code (#11153) 4 years ago
fr-fr Normalise include statements in core code (#11153) 4 years ago
gitbook/images
…
he-il Fix capitalisation of "GitHub" (#9184) 5 years ago
ja Normalise include statements in core code (#11153) 4 years ago
ko-kr Adding few Korean translated files (#5895) 5 years ago
pt-br Fix capitalisation of "GitHub" (#9184) 5 years ago
ru-ru Fix capitalisation of "GitHub" (#9184) 5 years ago
zh-cn Normalise include statements in core code (#11153) 4 years ago
.nojekyll
…
CNAME Create CNAME 7 years ago
README.md [Docs] Update links in main README.md (#11284) 4 years ago
_langs.md [Docs] add README translation in portuguese (#7016) 6 years ago
_summary.md 2020 November 28 Breaking Changes Update (#11053) 5 years ago
adc_driver.md Change analogRead calls to analogReadPin (#9023) 5 years ago
api_development_environment.md Add API documentation 5 years ago
api_development_overview.md Add API documentation 5 years ago
api_docs.md Add API documentation 5 years ago
api_overview.md Add API documentation 5 years ago
arm_debugging.md [Docs] fix docs (#7642) 5 years ago
breaking_changes.md 2020 November 28 Breaking Changes Update (#11053) 5 years ago
breaking_changes_instructions.md 2020 May 30 Breaking Changes Update (#9215) 5 years ago
cli.md Streamline the macos install process 5 years ago
cli_commands.md Updated usage of qmk c2json (#11148) 4 years ago
cli_configuration.md Fix capitalisation of "GitHub" (#9184) 5 years ago
cli_development.md Fix capitalisation of "GitHub" (#9184) 5 years ago
coding_conventions_c.md Update C coding conventions to match .clang-format config for i… (#8717) 5 years ago
coding_conventions_python.md Move everything to Python 3.6 (#8835) 5 years ago
compatible_microcontrollers.md adds support for the atmega328 (#9043) 5 years ago
config_options.md Normalise include statements in core code (#11153) 4 years ago
configurator_default_keymaps.md [Docs] add "Adding Default Keymaps to QMK Configurator" doc (#10049) 5 years ago
configurator_step_by_step.md Fix capitalisation of "GitHub" (#9184) 5 years ago
configurator_troubleshooting.md Polish Configurator section 5 years ago
contributing.md Add explicit id tags to externally linked headers 5 years ago
custom_matrix.md Add docs for 'CUSTOM_MATRIX = lite' (#7906) 5 years ago
custom_quantum_functions.md 2020 November 28 Breaking Changes Update (#11053) 5 years ago
documentation_best_practices.md [Docs] fix file path (#9540) 5 years ago
documentation_templates.md Add explicit id tags to externally linked headers 5 years ago
driver_installation_zadig.md MSYS and WSL installation improvements (#10593) 5 years ago
eeprom_driver.md Add i2c 24LC64 eeprom (#11200) 4 years ago
faq_build.md 50-qmk.rules: Move udev rules from documentation into a file (#10664) 5 years ago
faq_debug.md Add TMK "FEED" VID to list of deprecated udev rules 5 years ago
faq_general.md Rework the newbs guide around the qmk cli 5 years ago
faq_keymap.md make custom_keycode_names.md a faq entry instead 5 years ago
feature_advanced_keycodes.md Doc followup 9942 (#10473) 5 years ago
feature_audio.md Added keycodes for swapping and unswapping the Control and OS keys (#6110) 6 years ago
feature_auto_shift.md 2020 November 28 Breaking Changes Update (#11053) 5 years ago
feature_backlight.md 2020 November 28 Breaking Changes Update (#11053) 5 years ago
feature_bluetooth.md Add description in Bluetooth docs for requiring NKRO to be disabled (#10359) 5 years ago
feature_bootmagic.md Add support for Bootmagic lite when using SPLIT_HAND_PIN (#8347) 5 years ago
feature_combo.md changed type of process_combo_event argument in tutorial (#10621) 5 years ago
feature_command.md Update IS_COMMAND definitions to use MOD_MASK_SHIFT (#6348) 6 years ago
feature_debounce_type.md Fix typo within debounce documentation (#10600) 5 years ago
feature_dip_switch.md add DIP_SWITCH_MATRIX_GRID support (#8772) 5 years ago
feature_dynamic_macros.md Fix typo in docs/feature_dynamic_macros (#10085) 5 years ago
feature_encoders.md 2020 November 28 Breaking Changes Update (#11053) 5 years ago
feature_grave_esc.md Document an annoyance with Grave Escape and macOS Terminal (#5483) 6 years ago
feature_haptic_feedback.md 2020 November 28 Breaking Changes Update (#11053) 5 years ago
feature_hd44780.md fixed typo for clear lcd screen function in hd44780 docs (#9086) 5 years ago
feature_joystick.md 2020 November 28 Breaking Changes Update (#11053) 5 years ago
feature_key_lock.md Add explicit id tags to externally linked headers 5 years ago
feature_layers.md Redefine IS_LAYER_ON/OFF() as aliases for existing layer functions (#6352) 5 years ago
feature_layouts.md Add a mechanism for force building a particular community layout (#5027) 6 years ago
feature_leader_key.md Delete trailing period in documentation (#9416) 5 years ago
feature_led_indicators.md Indicator LEDs as config (#10816) 5 years ago
feature_led_matrix.md 2020 November 28 Breaking Changes Update (#11053) 5 years ago
feature_macros.md Normalise include statements in core code (#11153) 4 years ago
feature_mouse_keys.md 2020 November 28 Breaking Changes Update (#11053) 5 years ago
feature_oled_driver.md 2020 November 28 Breaking Changes Update (#11053) 5 years ago
feature_pointing_device.md Include `pointing_device_send` in docs (#9185) 5 years ago
feature_ps2_mouse.md Add movement hook to ps2_mouse (#8805) 5 years ago
feature_rawhid.md Updated Raw HID docs to clarify packet/report length (#11211) 4 years ago
feature_rgb_matrix.md [Docs] Add clarification on use of custom RGB Matrix effect (#11176) 4 years ago
feature_rgblight.md Added color wheel that have QMK HSV values. (#8997) 5 years ago
feature_sequencer.md 2020 November 28 Breaking Changes Update (#11053) 5 years ago
feature_space_cadet.md Added mod carry over from press to release. (#5866) 6 years ago
feature_split_keyboard.md [Docs] Add VBUS hack for teensys (#10986) 5 years ago
feature_stenography.md fix typo (#9695) 5 years ago
feature_swap_hands.md One shot support for swap hands (#8590) 5 years ago
feature_tap_dance.md Update features to use Custom Tapping Term when appropriate (#6259) 5 years ago
feature_terminal.md Remove build option firmware size impacts (#6947) 6 years ago
feature_thermal_printer.md
…
feature_unicode.md [Docs] Improve Unicode documentation (#8676) 5 years ago
feature_userspace.md Normalise include statements in core code (#11153) 4 years ago
feature_velocikey.md Velocikey: Match RGB animation speed to typing speed (#3754) 6 years ago
feature_wpm.md Add Word Per Minute calculation feature (#8054) 5 years ago
flashing.md Add `st-flash` flash target (#9964) 5 years ago
flashing_bootloadhid.md Install bootloadHid as part of qmk_install (#7463) 6 years ago
fuse.txt
…
getting_started_docker.md Reintegrate previous docker docs (#9084) 5 years ago
getting_started_github.md Fix capitalisation of "GitHub" (#9184) 5 years ago
getting_started_introduction.md [Docs] update git command and directory name of documents (#7619) 5 years ago
getting_started_make_guide.md Remove support for Adafruit EZ-Key (#10103) 5 years ago
getting_started_vagrant.md Remove Atmel FLIP from install scripts and documentation (#8822) 5 years ago
hand_wire.md make sure all our redirects are in order 5 years ago
hardware_avr.md Remove `DESCRIPTION` (#9732) 5 years ago
hardware_drivers.md Add customisable EEPROM driver selection (#7274) 5 years ago
hardware_keyboard_guidelines.md New command: qmk lint (#10761) 5 years ago
how_a_matrix_works.md refactor How a Matrix Works doc 5 years ago
how_keyboards_work.md Update URL for `60-keyboard.hwdb` (#7185) 6 years ago
i2c_driver.md Update i2c_driver.md (#10131) 5 years ago
index.html [Docs] redirect from /tutorial to /newbs (#10718) 5 years ago
internals_defines.md
…
internals_gpio_control.md 2020 November 28 Breaking Changes Update (#11053) 5 years ago
internals_input_callback_reg.md
…
internals_midi_device.md
…
internals_midi_device_setup_process.md
…
internals_midi_util.md
…
internals_send_functions.md
…
internals_sysex_tools.md
…
isp_flashing_guide.md [Docs] Update ISP Guide (#9748) 5 years ago
keycodes.md Issue 9942: Add LSA, RSA, RCS, LSA_T, RSA_T, and RCS_T (#9943) 5 years ago
keycodes_basic.md Add *OPT aliases for *ALT keycodes and macros (#8714) 5 years ago
keycodes_us_ansi_shifted.md Backslash-escape pipe character in keycode lists (#7157) 6 years ago
keymap.md [Docs] Clarify layer transparency keymap.md (#9081) 5 years ago
mod_tap.md [Docs] Add link to Tap-Hold Configuration Options from Mod-Tap (#10548) 5 years ago
newbs.md [Docs] redirect from /tutorial to /newbs (#10718) 5 years ago
newbs_building_firmware.md Add explicit id tags to externally linked headers 5 years ago
newbs_building_firmware_configurator.md Polish Configurator section 5 years ago
newbs_flashing.md [Docs] newbs_flashing.md: place bootloader instructions before Toolbox intro (#9077) 5 years ago
newbs_getting_started.md Refactor qmk_install.sh (#10681) 5 years ago
newbs_git_best_practices.md [Docs] Restructure of Git Best Practices doc (#7231) 6 years ago
newbs_git_resolving_merge_conflicts.md [Docs] Restructure of Git Best Practices doc (#7231) 6 years ago
newbs_git_resynchronize_a_branch.md [Docs] Fix minor differences in docs/newbs_git_resynchronize_a_branch.md (#7728) 5 years ago
newbs_git_using_your_master_branch.md Add explicit id tags to externally linked headers 5 years ago
newbs_learn_more_resources.md overhaul the newbs guide 5 years ago
newbs_testing_debugging.md Normalise include statements in core code (#11153) 4 years ago
one_shot_keys.md Update one_shot_keys.md (#10917) 5 years ago
other_eclipse.md fix two links on docs/other_eclipse.md (#8417) 5 years ago
other_vscode.md Update other_vscode.md of Japanese document (#10604) 5 years ago
platformdev_chibios_earlyinit.md Add dual-bank STM32 bootloader support, given GPIO toggle on BOOT0 to charge RC circuit. (#8778) 5 years ago
platformdev_selecting_arm_mcu.md Add documentation for selecting an Arm MCU (#9046) 5 years ago
power.txt
…
pr_checklist.md Recommend use of LED Indicator config (#10895) 5 years ago
proton_c_conversion.md Update ARM split keyboard docs (#9160) 5 years ago
qmk.css Some more tweaks to make everything look nice 7 years ago
qmk_custom_dark.css Fix darkmode (#8393) 5 years ago
qmk_custom_light.css Fix darkmode (#8393) 5 years ago
quantum_keycodes.md Add explicit id tags to externally linked headers 5 years ago
redirects.json Configuration system for CLI (#6708) 6 years ago
ref_functions.md [Docs] Clarify functionality of update_tri_layer_state (#10370) 5 years ago
reference_configurator_support.md Polish Configurator section 5 years ago
reference_glossary.md fixed link to Eclipse instructions (#9647) 5 years ago
reference_info_json.md Mark 'key_count' as optional within info.json docs (#10513) 5 years ago
reference_keymap_extras.md [Keymap Extra] Add French AZERTY (AFNOR - NF Z71-300) (#9644) 5 years ago
serial_driver.md Update ARM split keyboard docs (#9160) 5 years ago
spi_driver.md adds support for the atmega328 (#9043) 5 years ago
support.md Fix capitalisation of "GitHub" (#9184) 5 years ago
sw.js
…
syllabus.md [Docs] Fixed minor typos (#8860) 5 years ago
tap_hold.md 2020 November 28 Breaking Changes Update (#11053) 5 years ago
translating.md Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) 6 years ago
understanding_qmk.md Add Post Processing to process_record (#4892) 5 years ago
unit_testing.md Edit Unit Testing Documentation (#8961) 5 years ago
usb_nkro.txt
…
ws2812_driver.md add definition WS2812_BYTE_ORDER to fix RGB LED issues (#10184) 4 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 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

Totally new to QMK? There are two ways to get started:

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.