596c4a1f87
* Remove the bin/qmk script * remove bin/qmk from workflows |
||
|---|---|---|
| .. | ||
| ChangeLog | ||
| README.md | ||
| _summary.md | ||
| breaking_changes.md | ||
| cli.md | ||
| cli_configuration.md | ||
| contributing.md | ||
| driver_installation_zadig.md | ||
| faq.md | ||
| faq_build.md | ||
| faq_debug.md | ||
| faq_general.md | ||
| faq_keymap.md | ||
| flashing.md | ||
| getting_started_getting_help.md | ||
| getting_started_github.md | ||
| getting_started_introduction.md | ||
| newbs.md | ||
| newbs_best_practices.md | ||
| newbs_building_firmware.md | ||
| newbs_building_firmware_configurator.md | ||
| newbs_flashing.md | ||
| newbs_getting_started.md | ||
| newbs_learn_more_resources.md | ||
| newbs_testing_debugging.md | ||
README.md
Quantum Mechanical Keyboard Firmware
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).