Peter's keyboard firmware (QMK) https://qmk.fm/
Vous ne pouvez pas sélectionner plus de 25 sujets Les noms de sujets doivent commencer par une lettre ou un nombre, peuvent contenir des tirets ('-') et peuvent comporter jusqu'à 35 caractères.
fauxpark 53c51f1d16 A better new_project.sh (#5191) il y a 7 mois
..
gitbook/images RGB improvements (#1684) il y a 2 ans
zh Adds Proton C Conversion (#4661) il y a 11 mois
zh-cn Translate docs into Chinese (#5693) il y a 7 mois
.nojekyll Use docsfy to replace gitbook il y a 1 an
CNAME Create CNAME il y a 1 an
LANGS.md Second try at configuring i18n for docsify and gitbook (#4531) il y a 1 an
README.md Fix readme and contributing hyperlinks il y a 1 an
_summary.md [Docs] Smallish overhaul of the docs (#5281) il y a 8 mois
arm_debugging.md ARM SWD guide il y a 1 an
becoming_a_qmk_collaborator.md Tweak the wording in "Becoming a QMK Collaborator" il y a 1 an
compatible_microcontrollers.md Convert all headings to Title Case il y a 2 ans
config_options.md Change split_common to use RGBLIGHT_SPLIT (#5509) il y a 7 mois
contributing.md Update our style guide (#5500) il y a 7 mois
custom_quantum_functions.md Custom Tapping Term per key (#5009) il y a 8 mois
documentation_best_practices.md Fix up info boxes. il y a 1 an
documentation_templates.md Update Document Templates to reflect newer wording and URLs (#4006) il y a 1 an
faq.md Overhaul the Getting Started section and add a FAQ section il y a 2 ans
faq_build.md [Docs] Add udev rule for Input Club bootloaders (#5494) il y a 8 mois
faq_debug.md Trim trailing whitespace il y a 2 ans
faq_general.md Convert all headings to Title Case il y a 2 ans
faq_keymap.md Replace instances of KEYMAP with LAYOUT il y a 9 mois
feature_advanced_keycodes.md [Docs] Add Tap Dance example to the docs (#5326) il y a 9 mois
feature_audio.md [Docs] Add music_map to audio documentation (#5419) il y a 8 mois
feature_auto_shift.md Fix up info boxes. il y a 1 an
feature_backlight.md Fix #3566 use an hardware timer for software PWM stability (#3615) il y a 7 mois
feature_bluetooth.md Update Bluetooth docs (#4062) il y a 1 an
feature_bootmagic.md [Docs] Bootmagic Lite Caveat (#5069) il y a 10 mois
feature_combo.md Remove caveat about combos with shared keys (#5601) il y a 8 mois
feature_command.md Change Command keycode defaults to match corresponding Bootmagic codes (#5078) il y a 9 mois
feature_debounce_type.md Eager Per Row Debouncing added (added to Ergodox) (#5498) il y a 8 mois
feature_dynamic_macros.md Docs: Adjust dynamic macro docs to include more than the planck (#3509) il y a 1 an
feature_encoders.md Improve Encoder documentation (#5130) il y a 9 mois
feature_grave_esc.md Document an annoyance with Grave Escape and macOS Terminal (#5483) il y a 8 mois
feature_haptic_feedback.md Haptic feedback generalized - DRV2605 and solenoids (#4939) il y a 9 mois
feature_hd44780.md Integrating Peter Fleury's HD44780 LCD library (#3209) il y a 1 an
feature_key_lock.md Docs: Format Key Lock documentation (#3538) il y a 1 an
feature_layouts.md Add a mechanism for force building a particular community layout (#5027) il y a 9 mois
feature_leader_key.md Fix up process_leader to be a bit more optimized (#4662) il y a 11 mois
feature_led_matrix.md Add documentation for led matrix il y a 10 mois
feature_macros.md [Docs] Adding Alt↯Tab example macro (#5616) il y a 8 mois
feature_mouse_keys.md Update mouse keys docs (#5653) il y a 7 mois
feature_oled_driver.md Fixing readme from feedback il y a 7 mois
feature_pointing_device.md Fix some of the more obvious typos il y a 2 ans
feature_ps2_mouse.md Circuitry sample for PS/2 Mouse (#3959) il y a 1 an
feature_rgb_matrix.md RGB Matrix Animations: Three/six new reactive effects (wide, cross, nexus) (#5602) il y a 7 mois
feature_rgblight.md Define RGB colors (#5300) il y a 7 mois
feature_space_cadet_shift.md Improvements to Space Cadet Shift (#3856) il y a 10 mois
feature_space_cadet_shift_enter.md Docs: Format Space Cadet documentation (#3540) il y a 1 an
feature_stenography.md Improve state/chord handling and clean up namespace il y a 1 an
feature_swap_hands.md fix swap_hands keycodes in documentation (#3588) il y a 1 an
feature_tap_dance.md [Docs] Add Tap Dance example to the docs (#5326) il y a 9 mois
feature_terminal.md Added command history to terminal with other bug fixes, added new song to song_list.h (#2855) il y a 1 an
feature_thermal_printer.md Format keycode tables il y a 2 ans
feature_unicode.md [Docs] Add note about using Unicode Hex Input (#5248) il y a 9 mois
feature_userspace.md [Docs] Update the KC_MAKE example in Userspace docs (#5337) il y a 9 mois
feature_velocikey.md Velocikey: Match RGB animation speed to typing speed (#3754) il y a 9 mois
features.md Add LED Matrix to Features list for easy reference (#5280) il y a 9 mois
flashing.md Fix link to Caterina bootloader hex files (#5452) il y a 8 mois
fuse.txt convert docs to lowercase and underscores il y a 2 ans
getting_started_build_tools.md Revert "Update build instructions and docker file to download submodules" (#5533) il y a 8 mois
getting_started_getting_help.md Replace gitter links with Discord. (#3368) il y a 1 an
getting_started_github.md Fix doc typo il y a 1 an
getting_started_introduction.md Update config.h boilerplate to use `#pragma once` il y a 1 an
getting_started_make_guide.md Clean up debounce a bit (#5255) il y a 9 mois
getting_started_vagrant.md Fix some of the more obvious typos il y a 2 ans
hand_wire.md A better new_project.sh (#5191) il y a 7 mois
hardware.md Fix some of the more obvious typos il y a 2 ans
hardware_avr.md A better new_project.sh (#5191) il y a 7 mois
hardware_drivers.md OLED Driver Feature il y a 7 mois
hardware_keyboard_guidelines.md Clarify LAYOUT vs LAYOUT_all il y a 10 mois
how_keyboards_work.md Fix ascii art (#5407) il y a 9 mois
i2c_driver.md Next set of split_common changes (#4974) il y a 9 mois
index.html Adds Proton C Conversion (#4661) il y a 11 mois
internals_defines.md rename api docs to internals il y a 1 an
internals_gpio_control.md Grammatical fixes for GPIO Control doc (#4869) il y a 10 mois
internals_input_callback_reg.md rename api docs to internals il y a 1 an
internals_midi_device.md rename api docs to internals il y a 1 an
internals_midi_device_setup_process.md rename api docs to internals il y a 1 an
internals_midi_util.md rename api docs to internals il y a 1 an
internals_send_functions.md rename api docs to internals il y a 1 an
internals_sysex_tools.md rename api docs to internals il y a 1 an
isp_flashing_guide.md ISP Flashing Guide - atmega32a info (#4993) il y a 8 mois
keycodes.md Add C(), A() and G() to match already existing S() (#4673) il y a 10 mois
keycodes_basic.md Add new brightness aliases to keycodes_basic.md il y a 10 mois
keycodes_us_ansi_shifted.md Add caveats for shifted characters (#4192) il y a 1 an
keymap.md [Docs] Smallish overhaul of the docs (#5281) il y a 8 mois
newbs.md Contribute the MechMerlin QMK Configurator docs (#4986) il y a 10 mois
newbs_best_practices.md Docs: Adding QMK Git Conventions doc; formatting cleanup on Learning Resources doc (#3902) il y a 1 an
newbs_building_firmware.md Fix syntax for windows il y a 1 an
newbs_building_firmware_configurator.md Contribute the MechMerlin QMK Configurator docs (#4986) il y a 10 mois
newbs_flashing.md [Docs] Smallish overhaul of the docs (#5281) il y a 8 mois
newbs_getting_started.md [Docs] Recursively clone qmk_firmware repo (#5378) il y a 8 mois
newbs_learn_more_resources.md Docs: Adding QMK Git Conventions doc; formatting cleanup on Learning Resources doc (#3902) il y a 1 an
newbs_testing_debugging.md Add docs on using keyboard_post_init_user to enable debug modes il y a 9 mois
other_eclipse.md [Docs] Add VSCode guide to docs (#5124) il y a 9 mois
other_vscode.md [Docs] Add VSCode guide to docs (#5124) il y a 9 mois
porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md A better new_project.sh (#5191) il y a 7 mois
power.txt Trim trailing whitespace il y a 2 ans
proton_c_conversion.md Adds Proton C Conversion (#4661) il y a 11 mois
qmk.css Some more tweaks to make everything look nice il y a 1 an
quantum_keycodes.md Add EEPROM_RESET keycode to core code (#4234) il y a 1 an
redirects.json Docs: Format Space Cadet documentation (#3540) il y a 1 an
ref_functions.md Add tap_random_base64 and software timer info to Useful Functions doc (#4360) il y a 1 an
reference_configurator_support.md Docs: Supporting a keyboard in the QMK Configurator (#4396) il y a 1 an
reference_glossary.md Fix more broken links to the HID spec il y a 1 an
reference_info_json.md Add label to the info.json reference il y a 10 mois
sidebar.css override hamburger placement il y a 1 an
support.md Add support for PR and Issue templates to QMK_firmware GitHub (#4494) il y a 1 an
sw.js Fix up info boxes. il y a 1 an
understanding_qmk.md [Docs] Smallish overhaul of the docs (#5281) il y a 8 mois
unit_testing.md Trim trailing whitespace il y a 2 ans
usb_nkro.txt convert docs to lowercase and underscores il y a 2 ans

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.