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.
 
 
 
 
 
tzarc e5cab0b3cf Deploying to gh-pages from master @ 88fe5c16a5 🚀 2 years ago
..
ChangeLog Deploying to gh-pages from master @ aae3b35c0fc363e4a9246e774b714a7a1ef7b6c0 🚀 3 years ago
README.md Deploying to gh-pages from master @ c71d67ba3f4bdedbd5ec1e931e6ea9568fcd0d98 🚀 2 years ago
_summary.md Deploying to gh-pages from master @ aae3b35c0fc363e4a9246e774b714a7a1ef7b6c0 🚀 3 years ago
breaking_changes.md Deploying to gh-pages from master @ c71d67ba3f4bdedbd5ec1e931e6ea9568fcd0d98 🚀 2 years ago
cli.md Deploying to gh-pages from master @ 88fe5c16a5cdca5e3cf13ef3cd91f5f1e4898c37 🚀 2 years ago
cli_configuration.md Deploying to gh-pages from master @ aae3b35c0fc363e4a9246e774b714a7a1ef7b6c0 🚀 3 years ago
contributing.md Deploying to gh-pages from master @ c71d67ba3f4bdedbd5ec1e931e6ea9568fcd0d98 🚀 2 years ago
driver_installation_zadig.md Deploying to gh-pages from master @ 59c572eaf085d6a71f1455a4a309bb83f5d7d83f 🚀 2 years ago
faq.md Deploying to gh-pages from master @ aae3b35c0fc363e4a9246e774b714a7a1ef7b6c0 🚀 3 years ago
faq_build.md Deploying to gh-pages from master @ 59c572eaf085d6a71f1455a4a309bb83f5d7d83f 🚀 2 years ago
faq_debug.md Deploying to gh-pages from master @ 88fe5c16a5cdca5e3cf13ef3cd91f5f1e4898c37 🚀 2 years ago
faq_general.md Deploying to gh-pages from master @ aae3b35c0fc363e4a9246e774b714a7a1ef7b6c0 🚀 3 years ago
faq_keymap.md Deploying to gh-pages from master @ 88fe5c16a5cdca5e3cf13ef3cd91f5f1e4898c37 🚀 2 years ago
flashing.md Deploying to gh-pages from master @ 59c572eaf085d6a71f1455a4a309bb83f5d7d83f 🚀 2 years ago
getting_started_getting_help.md Deploying to gh-pages from master @ aae3b35c0fc363e4a9246e774b714a7a1ef7b6c0 🚀 3 years ago
getting_started_github.md Deploying to gh-pages from master @ 88fe5c16a5cdca5e3cf13ef3cd91f5f1e4898c37 🚀 2 years ago
getting_started_introduction.md Deploying to gh-pages from master @ aae3b35c0fc363e4a9246e774b714a7a1ef7b6c0 🚀 3 years ago
newbs.md Deploying to gh-pages from master @ 92a787ca4cdecbbb7e2c1394d5192d5fa3dabf6d 🚀 3 years ago
newbs_best_practices.md Deploying to gh-pages from master @ aae3b35c0fc363e4a9246e774b714a7a1ef7b6c0 🚀 3 years ago
newbs_building_firmware.md Deploying to gh-pages from master @ aae3b35c0fc363e4a9246e774b714a7a1ef7b6c0 🚀 3 years ago
newbs_building_firmware_configurator.md Deploying to gh-pages from master @ aae3b35c0fc363e4a9246e774b714a7a1ef7b6c0 🚀 3 years ago
newbs_flashing.md Deploying to gh-pages from master @ 59c572eaf085d6a71f1455a4a309bb83f5d7d83f 🚀 2 years ago
newbs_getting_started.md Deploying to gh-pages from master @ 92a787ca4cdecbbb7e2c1394d5192d5fa3dabf6d 🚀 3 years ago
newbs_learn_more_resources.md Deploying to gh-pages from master @ aae3b35c0fc363e4a9246e774b714a7a1ef7b6c0 🚀 3 years ago
newbs_testing_debugging.md Deploying to gh-pages from master @ 92a787ca4cdecbbb7e2c1394d5192d5fa3dabf6d 🚀 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).