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 Bot ce379ef458 Merge remote-tracking branch 'origin/master' into develop 2 years ago
..
ChangeLog French translation - FAQ section (#6995) 4 years ago
README.md [Core] [Docs] Remove travis-ci references (#13916) 2 years ago
_summary.md spi_master for AVR (#8299) 4 years ago
breaking_changes.md [Core] [Docs] Remove travis-ci references (#13916) 2 years ago
cli.md CLI/Docs: Fix the format commands' name (#13668) 2 years ago
cli_configuration.md French translation - FAQ section (#6995) 4 years ago
contributing.md [Core] [Docs] Remove travis-ci references (#13916) 2 years ago
driver_installation_zadig.md Cleanup junk characters, part 1 (#13282) 2 years ago
faq.md French translation - FAQ section (#6995) 4 years ago
faq_build.md Cleanup junk characters, part 1 (#13282) 2 years ago
faq_debug.md Cleanup junk characters, part 1 (#13282) 2 years ago
faq_general.md French translation - FAQ section (#6995) 4 years ago
faq_keymap.md Cleanup junk characters, part 1 (#13282) 2 years ago
flashing.md Cleanup junk characters, part 1 (#13282) 2 years ago
getting_started_getting_help.md French translation - FAQ section (#6995) 4 years ago
getting_started_github.md [Docs] Use HTTPS for images and links where possible (#11695) 3 years ago
getting_started_introduction.md [Docs] fix docs (#7642) 4 years ago
newbs.md [Docs] Use HTTPS for images and links where possible (#11695) 3 years ago
newbs_best_practices.md Fix capitalisation of "GitHub" (#9184) 3 years ago
newbs_building_firmware.md French translation - FAQ section (#6995) 4 years ago
newbs_building_firmware_configurator.md overhaul the newbs guide 4 years ago
newbs_flashing.md Cleanup junk characters, part 1 (#13282) 2 years ago
newbs_getting_started.md [Docs] Use HTTPS for images and links where possible (#11695) 3 years ago
newbs_learn_more_resources.md French translation - FAQ section (#6995) 4 years ago
newbs_testing_debugging.md [Docs] Use HTTPS for images and links where possible (#11695) 3 years ago

README.md

Quantum Mechanical Keyboard Firmware

Version courante Discord Statut de la doc Contributeurs GitHub Forks GitHub

Qu'est-ce que QMK Firmware?

QMK (Quantum Mechanical Keyboard) est une communauté open source qui maintient le firmware QMK, la QMK Toolbox (Boite à outil), qmk.fm et leurs documentations. QMK Firmware est un firmware dédié aux claviers qui est basé sur tmk_keyboard. Il offre des fonctionnalités très utiles pour les contrôleurs Atmel AVR, et, plus spécifiquement pour les produits d'OLKB, le clavier ErgoDox EZ, et pour les produits Clueboard. Il prend désormais aussi en charge les processeurs ARM qui utilisent ChibiOS. Vous pouvez l'utiliser pour contrôler un clavier personnalisé soudé à la main ou alors sur un clavier avec un PCB personnalisé.

Comment l'obtenir

Si vous souhaitez contribuer à une disposition de clavier (keymap), ou à des fonctionnalités de QMK alors le plus simple est de forker le dépôt avec GitHub puis cloner le dépôt localement pour y faire des changements. Vous pourrez pousser vos changements sur GitHub puis ouvrir un Pull Request depuis votre fork GitHub.

Sinon, vous pouvez aussi le télécharger directement en (zip, tar), ou le cloner avec git en ssh (git@github.com:qmk/qmk_firmware.git), ou https (https://github.com/qmk/qmk_firmware.git).

Comment le compiler

Avant d'être prêt à compiler vous allez devoir installer un environnement pour les développements AVR et/ou ARM. Une fois ceci fait, vous pourrez utiliser la commande make pour compiler le clavier et la disposition avec une commande de ce type :

make planck/rev4:default

Cette commande compilera la révision rev4 du clavier planck avec la disposition default. Notez que tous les claviers n'ont pas forcément de révisions (aussi appelées sous-projects ou dossiers, ou en anglais «subprojects» ou «folder»). Cette option peut donc être omise:

make preonic:default

Comment le personnaliser

QMK a beaucoup de fonctionnalités à explorer, et une documentation très abondante que vous pourrez parcourir. La plupart des fonctionnalités vous permettrons de modifier vos dispositions (keymaps) et de changer les codes de caractères (keycodes).