Etusivu Tutki Apua
Rekisteröidy Kirjaudu sisään
HuiJun
/
qmk_firmware
1
0
Fork 0
Tiedostot Ongelmat 0 Pull-pyynnöt 0 Wiki
Puu: 3c26f07f5a
Haarat Tagit
qmk_firmware
/
docs
noroadsleft 3c26f07f5a Grammatical fixes for GPIO Control doc (#4869) 6 vuotta sitten
..
gitbook 4580d3a730 RGB improvements (#1684) 7 vuotta sitten
zh 3cf179be61 Adds Proton C Conversion (#4661) 6 vuotta sitten
.nojekyll 9e5676650e Use docsfy to replace gitbook 7 vuotta sitten
CNAME 4d26137e2a Create CNAME 7 vuotta sitten
LANGS.md d5a06aec83 Second try at configuring i18n for docsify and gitbook (#4531) 6 vuotta sitten
README.md 73ddb764cc Fix readme and contributing hyperlinks 7 vuotta sitten
_summary.md 3cf179be61 Adds Proton C Conversion (#4661) 6 vuotta sitten
arm_debugging.md ac7b2d92bf ARM SWD guide 6 vuotta sitten
becoming_a_qmk_collaborator.md 1acaf2b2c2 Tweak the wording in "Becoming a QMK Collaborator" 6 vuotta sitten
compatible_microcontrollers.md 7b0356d1d4 Convert all headings to Title Case 7 vuotta sitten
config_options.md 28929ad017 Simplify split_common Code significantly (#4772) 6 vuotta sitten
contributing.md 7458ac9489 Update Contrib doc (#4068) 6 vuotta sitten
custom_quantum_functions.md 94ba2e5a9f Defined IS_(HOST_)LED_ON/OFF() and improved LED documentation (#4853) 6 vuotta sitten
documentation_best_practices.md 303f425c6b Fix up info boxes. 7 vuotta sitten
documentation_templates.md 8454fa5e9f Update Document Templates to reflect newer wording and URLs (#4006) 6 vuotta sitten
eclipse.md 8e99fbc884 Fixed typo of 'confid.h' to 'config.h' (#2448) 7 vuotta sitten
faq.md e6c638bed1 Overhaul the Getting Started section and add a FAQ section 7 vuotta sitten
faq_build.md b1e74aee43 Make sure that avr-gcc@7 gets linked into the path on MacOS. 6 vuotta sitten
faq_debug.md bb53635f33 Trim trailing whitespace 7 vuotta sitten
faq_general.md 7b0356d1d4 Convert all headings to Title Case 7 vuotta sitten
faq_keymap.md 75a51659ab Add tap_random_base64 and software timer info to Useful Functions doc (#4360) 6 vuotta sitten
feature_advanced_keycodes.md 5287b94e6f Pointed LM Docs at expected keycodes (#4835) 6 vuotta sitten
feature_audio.md 9739d6ba0a Docs: Clarify audio keycodes (#4620) 6 vuotta sitten
feature_auto_shift.md 303f425c6b Fix up info boxes. 7 vuotta sitten
feature_backlight.md 0cda2f43e2 Backlight status functions (#4259) 6 vuotta sitten
feature_bluetooth.md 914d42acd0 Update Bluetooth docs (#4062) 6 vuotta sitten
feature_bootmagic.md 7373d5b394 Update feature_bootmagic.md (#4290) 6 vuotta sitten
feature_combo.md 26a201e687 fix example to reflect caveat 6 vuotta sitten
feature_command.md 25d757284c Docs: Fix Command docs escaping (#3523) 6 vuotta sitten
feature_dynamic_macros.md 6caea0acfb Docs: Adjust dynamic macro docs to include more than the planck (#3509) 6 vuotta sitten
feature_encoders.md 16302be5ad docs typo (#4584) 6 vuotta sitten
feature_grave_esc.md 2bc34b09cd Docs: Format Grave Escape documentation (#3536) 6 vuotta sitten
feature_hd44780.md bbea9dadbc Integrating Peter Fleury's HD44780 LCD library (#3209) 7 vuotta sitten
feature_key_lock.md c11a26ba54 Docs: Format Key Lock documentation (#3538) 6 vuotta sitten
feature_layouts.md 08c682c193 Docs: Add docs for the `LAYOUT_*` macro to layouts (#3772) 6 vuotta sitten
feature_leader_key.md afd5cda4a0 Fix up process_leader to be a bit more optimized (#4662) 6 vuotta sitten
feature_macros.md 02d44beb44 Fix up tap_code functionality (#4609) 6 vuotta sitten
feature_mouse_keys.md 7f7f763598 Fixed dead links (#2451) 7 vuotta sitten
feature_pointing_device.md af37bb2f78 Fix some of the more obvious typos 7 vuotta sitten
feature_ps2_mouse.md 58b9b22670 Circuitry sample for PS/2 Mouse (#3959) 6 vuotta sitten
feature_rgb_matrix.md 504bf11769 Allows disabling rgb effects in userspace (#4422) 6 vuotta sitten
feature_rgblight.md 9e6ee47779 Added noeeprom versions of set hue, sat, val, and step 6 vuotta sitten
feature_space_cadet_shift.md 03ad6927cb Docs: Format Space Cadet documentation (#3540) 6 vuotta sitten
feature_space_cadet_shift_enter.md 03ad6927cb Docs: Format Space Cadet documentation (#3540) 6 vuotta sitten
feature_stenography.md c0baf2a964 Improve state/chord handling and clean up namespace 7 vuotta sitten
feature_swap_hands.md fd085837e1 fix swap_hands keycodes in documentation (#3588) 6 vuotta sitten
feature_tap_dance.md 641bbeb41a Remove userspace info from Quad-Function Tap Dance example (#4631) 6 vuotta sitten
feature_terminal.md 5112af887a Added command history to terminal with other bug fixes, added new song to song_list.h (#2855) 7 vuotta sitten
feature_thermal_printer.md 4c675a83ba Format keycode tables 7 vuotta sitten
feature_unicode.md cd9262d7b2 Improve consistency in UNICODEMAP code and docs, update docs/understanding_qmk (#4774) 6 vuotta sitten
feature_userspace.md f1b2d46eaf Spell-check update for Userspace documentation 6 vuotta sitten
features.md 2dc14d1cb3 Fixed incorrect link to feature_combo.md in features.md docs file. Was linked to feature_combos.md, but _sidebar.md, _summary.md, and config_options.md all link to feature_combo.md. Assuming that it should not be pluralized. (#4411) 6 vuotta sitten
flashing.md 292a87ad04 Instructions on how to flash via STM32 bootloader (#4316) 6 vuotta sitten
fuse.txt ca01d94005 convert docs to lowercase and underscores 8 vuotta sitten
getting_started_build_tools.md aad4319b40 docs: Add Manjaro/Arch dependencies on getting started page (#2701) 6 vuotta sitten
getting_started_getting_help.md 48913153c3 Replace gitter links with Discord. (#3368) 7 vuotta sitten
getting_started_github.md 76aa2baf3e Fix doc typo 6 vuotta sitten
getting_started_introduction.md c5c112ae29 Update config.h boilerplate to use `#pragma once` 7 vuotta sitten
getting_started_make_guide.md 28929ad017 Simplify split_common Code significantly (#4772) 6 vuotta sitten
getting_started_vagrant.md af37bb2f78 Fix some of the more obvious typos 7 vuotta sitten
hand_wire.md bb53635f33 Trim trailing whitespace 7 vuotta sitten
hardware.md af37bb2f78 Fix some of the more obvious typos 7 vuotta sitten
hardware_avr.md ab3fbfdb3b Update hardware config warnings to be more accurate 6 vuotta sitten
hardware_drivers.md fdd0f91527 ISSI31FL3733 driver (#3679) 6 vuotta sitten
hardware_keyboard_guidelines.md 9fb1e5d171 Remove bootloader key as it is no longer used (#3093) 7 vuotta sitten
how_keyboards_work.md d08f9cb6e4 Fix grammar, typos, and the link to HID specification 6 vuotta sitten
i2c_driver.md caa293a8f7 Remove duplicate row from Available functions table in i2c_driver doc (#4416) 6 vuotta sitten
index.html 3cf179be61 Adds Proton C Conversion (#4661) 6 vuotta sitten
internals_defines.md ae7284edb8 rename api docs to internals 7 vuotta sitten
internals_gpio_control.md 3c26f07f5a Grammatical fixes for GPIO Control doc (#4869) 6 vuotta sitten
internals_input_callback_reg.md ae7284edb8 rename api docs to internals 7 vuotta sitten
internals_midi_device.md ae7284edb8 rename api docs to internals 7 vuotta sitten
internals_midi_device_setup_process.md ae7284edb8 rename api docs to internals 7 vuotta sitten
internals_midi_util.md ae7284edb8 rename api docs to internals 7 vuotta sitten
internals_send_functions.md ae7284edb8 rename api docs to internals 7 vuotta sitten
internals_sysex_tools.md ae7284edb8 rename api docs to internals 7 vuotta sitten
isp_flashing_guide.md ac46378ac6 Update ISP flashing guide with pre-compiled binary (#3217) 6 vuotta sitten
keycodes.md ba05f9667b Add new brightness aliases to keycodes_basic.md 6 vuotta sitten
keycodes_basic.md ba05f9667b Add new brightness aliases to keycodes_basic.md 6 vuotta sitten
keycodes_us_ansi_shifted.md 9374c0c9db Add caveats for shifted characters (#4192) 6 vuotta sitten
keymap.md 334e2629df Remove redefinition of `_______` in documentation example (#3924) 6 vuotta sitten
newbs.md 80dfd34fe4 Add additional resource links (#4594) 6 vuotta sitten
newbs_best_practices.md 480651cf9d Docs: Adding QMK Git Conventions doc; formatting cleanup on Learning Resources doc (#3902) 6 vuotta sitten
newbs_building_firmware.md a5b10e5da2 Fix syntax for windows 6 vuotta sitten
newbs_flashing.md 303f425c6b Fix up info boxes. 7 vuotta sitten
newbs_getting_started.md 3dec80b774 Improve wording, punctuation and capitalization in newbs_getting_started guide (#4342) 6 vuotta sitten
newbs_learn_more_resources.md 480651cf9d Docs: Adding QMK Git Conventions doc; formatting cleanup on Learning Resources doc (#3902) 6 vuotta sitten
newbs_testing_debugging.md 90f9fb4eee Fixed docs/newbs_testing_debugging.md and tmk_core/common/print.h 6 vuotta sitten
porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md af37bb2f78 Fix some of the more obvious typos 7 vuotta sitten
power.txt bb53635f33 Trim trailing whitespace 7 vuotta sitten
proton_c_conversion.md 3cf179be61 Adds Proton C Conversion (#4661) 6 vuotta sitten
qmk.css ccc87421e7 Some more tweaks to make everything look nice 7 vuotta sitten
quantum_keycodes.md 6e44f94f21 Add EEPROM_RESET keycode to core code (#4234) 6 vuotta sitten
redirects.json 03ad6927cb Docs: Format Space Cadet documentation (#3540) 6 vuotta sitten
ref_functions.md 75a51659ab Add tap_random_base64 and software timer info to Useful Functions doc (#4360) 6 vuotta sitten
reference_configurator_support.md d8f090e559 Docs: Supporting a keyboard in the QMK Configurator (#4396) 6 vuotta sitten
reference_glossary.md dad79cafcd Fix more broken links to the HID spec 6 vuotta sitten
sidebar.css 7d49a17781 override hamburger placement 7 vuotta sitten
support.md 2ad2b73d68 Add support for PR and Issue templates to QMK_firmware GitHub (#4494) 6 vuotta sitten
sw.js 303f425c6b Fix up info boxes. 7 vuotta sitten
understanding_qmk.md cd9262d7b2 Improve consistency in UNICODEMAP code and docs, update docs/understanding_qmk (#4774) 6 vuotta sitten
unit_testing.md bb53635f33 Trim trailing whitespace 7 vuotta sitten
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores 8 vuotta sitten

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.