From bed98091aa4e2b555e092760d49856e38f2c9657 Mon Sep 17 00:00:00 2001 From: Xavier Hahn Date: Sun, 3 Nov 2019 17:02:44 +0100 Subject: French translation - FAQ section (#6995) * Translated faq.md and added all other files (copy from English) * Translated driver_installation_zadig.md in French * Translated faq_build.md in French * Translated faq_debug in French * Translateed faq_general.md in French * Translated first part of faq_keymap.md * Renamed docs/fr-FR folder to docs/fr-fr * Finished translation of faq_keymap.md * Update faq_build.md * Review (#3) * Review * Update docs/fr-fr/faq_keymap.md * Update docs/fr-fr/faq_debug.md * Fix some PR comments Co-Authored-By: Noan Mousy <4sstylz@protonmail.ch> Co-Authored-By: Wermeille Bastien --- docs/fr-FR/ChangeLog/20190830.md | 52 --- docs/fr-FR/README.md | 32 -- docs/fr-FR/_summary.md | 125 ------- docs/fr-FR/breaking_changes.md | 107 ------ docs/fr-FR/cli.md | 146 -------- docs/fr-FR/cli_configuration.md | 121 ------- docs/fr-FR/contributing.md | 154 --------- docs/fr-FR/flashing.md | 239 -------------- docs/fr-FR/getting_started_getting_help.md | 15 - docs/fr-FR/getting_started_github.md | 61 ---- docs/fr-FR/getting_started_introduction.md | 62 ---- docs/fr-FR/newbs.md | 23 -- docs/fr-FR/newbs_best_practices.md | 161 --------- docs/fr-FR/newbs_building_firmware.md | 81 ----- docs/fr-FR/newbs_building_firmware_configurator.md | 105 ------ docs/fr-FR/newbs_flashing.md | 367 --------------------- docs/fr-FR/newbs_getting_started.md | 101 ------ docs/fr-FR/newbs_learn_more_resources.md | 14 - docs/fr-FR/newbs_testing_debugging.md | 102 ------ 19 files changed, 2068 deletions(-) delete mode 100644 docs/fr-FR/ChangeLog/20190830.md delete mode 100644 docs/fr-FR/README.md delete mode 100644 docs/fr-FR/_summary.md delete mode 100644 docs/fr-FR/breaking_changes.md delete mode 100644 docs/fr-FR/cli.md delete mode 100644 docs/fr-FR/cli_configuration.md delete mode 100644 docs/fr-FR/contributing.md delete mode 100644 docs/fr-FR/flashing.md delete mode 100644 docs/fr-FR/getting_started_getting_help.md delete mode 100644 docs/fr-FR/getting_started_github.md delete mode 100644 docs/fr-FR/getting_started_introduction.md delete mode 100644 docs/fr-FR/newbs.md delete mode 100644 docs/fr-FR/newbs_best_practices.md delete mode 100644 docs/fr-FR/newbs_building_firmware.md delete mode 100644 docs/fr-FR/newbs_building_firmware_configurator.md delete mode 100644 docs/fr-FR/newbs_flashing.md delete mode 100644 docs/fr-FR/newbs_getting_started.md delete mode 100644 docs/fr-FR/newbs_learn_more_resources.md delete mode 100644 docs/fr-FR/newbs_testing_debugging.md (limited to 'docs/fr-FR') diff --git a/docs/fr-FR/ChangeLog/20190830.md b/docs/fr-FR/ChangeLog/20190830.md deleted file mode 100644 index cb223be31a..0000000000 --- a/docs/fr-FR/ChangeLog/20190830.md +++ /dev/null @@ -1,52 +0,0 @@ -# QMK Breaking Change - 30 août 2019 - -Quatre fois par an, QMK lance un processus pour fusionner les Breaking Changes. Un Breaking Change est un changement qui modifie la manière dont QMK fonctionne introduisant des incompatibilités ou des comportements dangereux. Nous n'effectuons ces changements que 4 fois par an afin que les utilisateurs n'aient pas peur de casser leurs keymaps en mettant à jour leur version de QMK. - -Ce document présente les fusions de Breaking Change. Voici la liste des changements. - -## Formattage de code Core avec clang-format - -* Tous les fichiers core (`drivers/`, `quantum/`, `tests/`, et `tmk_core/`) seront formatés avec clang-format -* Un processus travis pour reformatter les PRs lors de la fusion a été mis en place -* Vous pouvez utiliser la nouvelle commande CLI `qmk cformat` afin de formater avant de soumettre votre PR si vous le souhaitez. - -## Nettoyage des descripteurs LUFA USB - -* Nettoyage du code lié aux descripteurs USB HID sur les claviers AVR, afin de les rendre plus simple à lire et compréhensibles -* Plus d'information: https://github.com/qmk/qmk_firmware/pull/4871 -* Normalement pas de changement de fonctionnement et aucune keymap modifiée. - -## Migration des entrées de `ACTION_LAYER_MOMENTARY()` dans `fn_actions` vers des keycodes `MO()` - -* `fn_actions` est déprécié, et ses fonctionnalités ont été remplacées par des keycodes directs et `process_record_user()` -* Supprimer cette fonctionnalité obsolète devrait aboutir à une réduction importante de la taille du firmware et de la complexité du code -* Il est recommandé que toutes les keymaps affectées remplacent `fn_actions` vers les fonctionnalités de [keycode custom](https://docs.qmk.fm/#/custom_quantum_functions) et [macro](https://docs.qmk.fm/#/feature_macros) - -## Mise à jour Atreus vers les conventions de codage courantes - -* Les doublons include guards ont contourné le comportement de traitement des headers attendu -* Il est recommandé pour toutes les keymaps affectées de supprimer le doublon de `/config.h` et `/keymaps//config.h` et de ne garder que des surcharges au niveau keymap - -## Récupération des changements de fichier keymap langage de la fork ZSA - -* Corrige une issue dans le fichier `keymap_br_abnt2.h` qui inclut la mauvaise souce (`keymap_common.h` au lieu de `keymap.h`) -* Met à jour le fichier `keymap_swedish.h` afin d'être spécifique au suédois et plus "nordique" en général. -* Toutes les keymaps qui utilisent ceci devront supprimer `NO_*` et le remplacer par `SE_*`. - -## Mise à jour du repo afin d'utiliser LUFA comme un sous-module git - -* `/lib/LUFA` supprimé du dépôt -* LUFA, définis comme un sous-module, pointe vers qmk/lufa -* Ceci devrait ajouter plus de flexibilité vers LUFA, et nous permet de garder le sous-module à jour bien plus facilement. Il avait environ 2 ans de retard, sans manière simple de corriger. Ce changement devrait simplifier la mise à jour dans le futur. - -## Migration des entrées `ACTION_BACKLIGHT_*()` dans `fn_actions` vers des keycodes `BL_` - -* `fn_actions` est déprécié, et ses fonctionnalités ont été remplacées par des keycodes directs et `process_record_user()` -* Toutes les keymaps utilisant ces actions doivent avoir les clés `KC_FN*` remplacées par les clés `BL_*` équivalentes -* Si vous utilisez actuellement `KC_FN*` vous devrez remplacer `fn_actions` avec les fonctionnalités de [keycode custom](https://docs.qmk.fm/#/custom_quantum_functions) et [macro](https://docs.qmk.fm/#/feature_macros) - -## Remplacer l'alias `KC_DELT` par `KC_DEL` - -* `KC_DELT` était un alias redondant et non documenté pour `KC_DELETE` -* Il a été supprimé et toutes ses utilisations ont été remplacées par l'alias plus courant `KC_DEL` -* Environ 90 keymaps (surtout des boards ErgoDox) ont été modifiées à cette fin diff --git a/docs/fr-FR/README.md b/docs/fr-FR/README.md deleted file mode 100644 index d3591554b0..0000000000 --- a/docs/fr-FR/README.md +++ /dev/null @@ -1,32 +0,0 @@ -# Quantum Mechanical Keyboard Firmware - -[![Version courante](https://img.shields.io/github/tag/qmk/qmk_firmware.svg)](https://github.com/qmk/qmk_firmware/tags) -[![Statut du build](https://travis-ci.org/qmk/qmk_firmware.svg?branch=master)](https://travis-ci.org/qmk/qmk_firmware) -[![Discord](https://img.shields.io/discord/440868230475677696.svg)](https://discord.gg/Uq7gcHh) -[![Statut de la doc](https://img.shields.io/badge/docs-ready-orange.svg)](https://docs.qmk.fm) -[![Contributeurs Github](https://img.shields.io/github/contributors/qmk/qmk_firmware.svg)](https://github.com/qmk/qmk_firmware/pulse/monthly) -[![Forks Github](https://img.shields.io/github/forks/qmk/qmk_firmware.svg?style=social&label=Fork)](https://github.com/qmk/qmk_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](http://github.com/tmk/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](http://olkb.com), le clavier [ErgoDox EZ](http://www.ergodox-ez.com), et pour les [produits Clueboard](http://clueboard.co/). 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](https://github.com/qmk/qmk_firmware#fork-destination-box) puis cloner le dépôt localement pour y faire des changements. Vous pourrez pousser vos changements sur github puis ouvrir un [Pull Request](https://github.com/qmk/qmk_firmware/pulls) depuis votre fork Github. - -Sinon, vous pouvez aussi le télécharger directement en ([zip](https://github.com/qmk/qmk_firmware/zipball/master), [tar](https://github.com/qmk/qmk_firmware/tarball/master)), 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](getting_started_build_tools.md) 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](features.md) à explorer, et [une documentation](http://docs.qmk.fm) très abondante que vous pourrez parcourir. La plupart des fonctionnalités vous permettrons de modifier vos [dispositions](keymap.md) (keymaps) et de changer [les codes de caractères](keycodes.md) (keycodes). diff --git a/docs/fr-FR/_summary.md b/docs/fr-FR/_summary.md deleted file mode 100644 index 16ae82d063..0000000000 --- a/docs/fr-FR/_summary.md +++ /dev/null @@ -1,125 +0,0 @@ -**En Français** - -* [Guide pour débutant complet](fr-FR/newbs.md) - * [Pour débuter](fr-FR/newbs_getting_started.md) - * [Compiler son premier firmware](fr-FR/newbs_building_firmware.md) - * [Flasher le Firmware](fr-FR/newbs_flashing.md) - * [Test et Débuggage](fr-FR/newbs_testing_debugging.md) - * [Bonnes pratiques Git](fr-FR/newbs_best_practices.md) - * [Ressources d'apprentissage](fr-FR/newbs_learn_more_resources.md) - -* [Les bases de QMK](fr-FR/README.md) - * [Indroduction à QMK](fr-FR/getting_started_introduction.md) - * [QMK CLI](fr-FR/cli.md) - * [Configuration de la CLI QMK](fr-FR/cli_configuration.md) - * [Contribuer à QMK](fr-FR/contributing.md) - * [Comment utiliser GitHub](fr-FR/getting_started_github.md) - * [Trouver de l'aide](fr-FR/getting_started_getting_help.md) - -* [Breaking changes](fr-FR/breaking_changes.md) - * [30 août 2019](fr-FR/ChangeLog/20190830.md) - -**En Anglais** - -* [FAQ](faq.md) - * [FAQ Générale](faq_general.md) - * [Compiler QMK](faq_build.md) - * [Débugguer / Dépanner QMK](faq_debug.md) - * [Keymap / Disposition](faq_keymap.md) - * [Installer les drivers avec Zadig](driver_installation_zadig.md) - -* Guides détaillés - * [Installation des outils de compilation](getting_started_build_tools.md) - * [Guide Vagrant](getting_started_vagrant.md) - * [Commandes de compilations](getting_started_make_guide.md) - * [Flasher les firmwares](fr-fr/flashing.md) - * [Personnaliser les fonctionnalités](custom_quantum_functions.md) - * [Aperçu des fonctionnalités des dispositions](keymap.md) - -* [Hardware](hardware.md) - * [Processeurs AVR](hardware_avr.md) - * [Pilotes / Drivers](hardware_drivers.md) - -* Réferences - * [Lignes de conduite des claviers](hardware_keyboard_guidelines.md) - * [Options de configurations](config_options.md) - * [Keycodes / Codes des caractères](keycodes.md) - * [Conventions de codage - C](coding_conventions_c.md) - * [Conventions de codage - Python](coding_conventions_python.md) - * [Meilleurs pratiques sur la documentation](documentation_best_practices.md) - * [Modèles de documentation](documentation_templates.md) - * [Glossaire](reference_glossary.md) - * [Tests unitaires](unit_testing.md) - * [Fonctions utiles](ref_functions.md) - * [Support de configuration](reference_configurator_support.md) - * [Format du fichier info.json](reference_info_json.md) - * [Développer la CLI en Python](cli_development.md) - -* [Fonctionnalités](features.md) - * [Keycodes basiques](keycodes_basic.md) - * [Touches utilisées avec Shift (US ANSI)](keycodes_us_ansi_shifted.md) - * [Keycodes quantiques](quantum_keycodes.md) - * [Keycodes avancés](feature_advanced_keycodes.md) - * [Fonctionnalités audio](feature_audio.md) - * [Majuscule automatique](feature_auto_shift.md) - * [Rétroéclairage](feature_backlight.md) - * [Bluetooth](feature_bluetooth.md) - * [Bootmagic](feature_bootmagic.md) - * [Combos](feature_combo.md) - * [Commande](feature_command.md) - * [API anti-rebond](feature_debounce_type.md) - * [DIP Switch](feature_dip_switch.md) - * [Macros dynamiques](feature_dynamic_macros.md) - * [Interrupteurs rotatifs](feature_encoders.md) - * [Grave Escape](feature_grave_esc.md) - * [Retour haptique](feature_haptic_feedback.md) - * [Contrôleur LCD HD44780](feature_hd44780.md) - * [Touche à verrou / Lock-key](feature_key_lock.md) - * [Dispositions / layouts](feature_layouts.md) - * [Touche leader](feature_leader_key.md) - * [Matrice LED](feature_led_matrix.md) - * [Macros](feature_macros.md) - * [Boutons de souris](feature_mouse_keys.md) - * [Pilotes / Drivers OLED](feature_oled_driver.md) - * [Touche one-shot](feature_advanced_keycodes.md#one-shot-keys) - * [Périphériques de pointage](feature_pointing_device.md) - * [Souris PS/2](feature_ps2_mouse.md) - * [Éclairage RGB](feature_rgblight.md) - * [Matrice RGB](feature_rgb_matrix.md) - * [Space Cadet](feature_space_cadet.md) - * [Claviers scindés / splittés](feature_split_keyboard.md) - * [Stenographie](feature_stenography.md) - * [Inversion des mains](feature_swap_hands.md) - * [Tap Dance](feature_tap_dance.md) - * [Terminale](feature_terminal.md) - * [Imprimante thermique](feature_thermal_printer.md) - * [Caractères unicodes](feature_unicode.md) - * [Dossier utilisateur](feature_userspace.md) - * [Velocikey](feature_velocikey.md) - -* Pour les makers et les bricoleurs - * [Guide des claviers soudés à la main](hand_wire.md) - * [Guide de flash de l’ISP](isp_flashing_guide.md) - * [Guide du débogage ARM](arm_debugging.md) - * [Drivers i2c](i2c_driver.md) - * [Contrôles des GPIO](internals_gpio_control.md) - * [Conversion en Proton C](proton_c_conversion.md) - -* Pour aller plus loin - * [Comment fonctionnent les claviers](how_keyboards_work.md) - * [Comprendre QMK](understanding_qmk.md) - -* Autres sujets - * [Utiliser Eclipse avec QMK](other_eclipse.md) - * [Utiliser VSCode avec QMK](other_vscode.md) - * [Support](support.md) - * [Comment ajouter des traductions](translating.md) - -* À l’intérieur de QMK (En cours de documentation) - * [Définitions](internals_defines.md) - * [Input Callback Reg](internals_input_callback_reg.md) - * [Appareils Midi](internals_midi_device.md) - * [Installation d’un appareil Midi](internals_midi_device_setup_process.md) - * [Utilitaires Midi](internals_midi_util.md) - * [Fonctions Midi](internals_send_functions.md) - * [Outils Sysex](internals_sysex_tools.md) diff --git a/docs/fr-FR/breaking_changes.md b/docs/fr-FR/breaking_changes.md deleted file mode 100644 index 53bbb2212a..0000000000 --- a/docs/fr-FR/breaking_changes.md +++ /dev/null @@ -1,107 +0,0 @@ -# Breaking changes - -Ce document décrit le processus de QMK pour la gestion des breaking changes. Un breaking change est un changement qui modifie la manière dont QMK fonctionne introduisant des incompatibilités ou des comportements dangereux. Nous limitons ces changements afin que les utilisateurs n'aient pas peur de casser leurs keymaps en mettant à jour leur version de QMK. - -La période de breaking change est quand nous allons fusionner un PR qui change QMK d'une manière dangereuse ou inattendue. Il y a une période interne de test afin de nous assurer que les problèmes résiduels sont rares ou impossible à prévoir. - -## Qu'est-ce qui a été inclus dans des Breaking Changes précédents? - -* [30 août 2019](ChangeLog/20190830.md) - -## Quand va être le prochain Breaking Change? - -Le prochain Breaking Change est planifié pour le 29 novembre. - -### Dates importantes - -* [x] 21 septembre 2019 - `future` est créé. Il va être rebasé de manière hebdomadaire. -* [ ] 01 novembre 2019 - `future` fermé aux nouveaux PRs. -* [ ] 01 novembre 2019 - Appel aux testeurs. -* [ ] 27 novembre 2019 - `master` est bloqué, pas de PRs fusionnés. -* [ ] 29 novembre 2019 - `future` est fusionné dans `master`. -* [ ] 30 novembre 2019 - `master` est débloqué. Les PRs peuvent à nouveau être fusionnés. - -## Quels changements seront inclus? - -Pour voir une liste de candidats de breaking changes, vous pouvez regarder la liste des [labels `breaking_change`](https://github.com/qmk/qmk_firmware/pulls?q=is%3Aopen+label%3Abreaking_change+is%3Apr). De nouveaux changements peuvent être ajoutés entre maintenant et lorsque `future` est fermée, et un PR avec ce label n'est pas garanti d'être fusionné. - -Si vous souhaitez que votre breaking change soit inclus dans ce tour, vous devez créer un PR avec le label `breaking_change` et faire en sorte qu'il soit accepté avant que `future` ne soit fermé. Une fois `future` fermé, aucun nouveau breaking change sera accepté. - -Critère d'acceptation: - -* Le PR est complété et prêt à fusionner -* Le PR a un ChangeLog - -# Checklists - -Cette section documente plusieurs processus que nous utilisons en lançant le processus de Breaking Change. - -## Rebase `future` de `master` - -Ceci est lancé chaque vendredi tant que `future` est ouvert. - -Processus: - -``` -cd qmk_firmware -git checkout master -git pull --ff-only -git checkout future -git rebase master -git push --force -``` - -## Créer la branche `future` - -Ceci est fait immédiatement après la fusion de la branche `future` précédente. - -* `qmk_firmware` git commands - * [ ] `git checkout master` - * [ ] `git pull --ff-only` - * [ ] `git checkout -b future` - * [ ] Modifie `readme.md` - * [ ] Ajoute un message en haut qui indique que c'est une branche de test. - * [ ] Ajoute un lien vers ce document - * [ ] `git commit -m 'Branch point for Breaking Change'` - * [ ] `git tag breakpoint___
` - * [ ] `git tag ` # Evite que le label point d'arrêt soit confondu par un incrément de version - * [ ] `git push origin future` - * [ ] `git push --tags` - -## 4 Semaines Avant la Fusion - -* `future` est maintenant fermé aux nouveaux PRs, seul des correctifs pour les PRs courants peuvent être mergés -* Envoi de l'appel aux testeurs - * [ ] Discord - * [ ] GitHub PR - * [ ] https://reddit.com/r/olkb - -## 1 Semaine Avant la Fusion - -* Annonce que master sera fermée entre <2 jours avant> à - * [ ] Discord - * [ ] GitHub PR - * [ ] https://reddit.com/r/olkb - -## 2 Jours Avant la Fusion - -* Annonce que master est fermé pour 2 jours - * [ ] Discord - * [ ] GitHub PR - * [ ] https://reddit.com/r/olkb - -## Jour de la fusion - -* `qmk_firmware` git commands - * [ ] `git checkout future` - * [ ] `git pull --ff-only` - * [ ] `git rebase origin/master` - * [ ] Modifie `readme.md` - * [ ] Supprimer les notes à propos de `future` - * [ ] Regroupe ChangeLog dans un fichier. - * [ ] `git commit -m 'Merge point for Breaking Change'` - * [ ] `git push origin future` -* Actions sur Github - * [ ] Crée un PR pour `future` - * [ ] S'assurer que Travis ne relève aucun problème - * [ ] Fusion le PR `future` diff --git a/docs/fr-FR/cli.md b/docs/fr-FR/cli.md deleted file mode 100644 index 4281536458..0000000000 --- a/docs/fr-FR/cli.md +++ /dev/null @@ -1,146 +0,0 @@ -# La CLI de QMK - -Cette page décrit comment configurer et utiliser la CLI QMK. - -# Vue d'ensemble - -La CLI de QMK permet de simplifier la compilation et l'interaction avec les claviers QMK. Nous avons défini plusieurs commandes pour simplifier et rationaliser les tâches telles qu'obtenir et compiler le firmware QMK, créer de nouvelles keymaps, et plus. - -* [CLI globale](#global-cli) -* [CLI locale](#local-cli) -* [Les commandes CLI](#cli-commands) - -# Pré-requis - -La CLI nécessite Python 3.5 ou plus récent. Nous essayons de limiter le nombre de pré-requis, mais vous allez aussi devoir installer les paquets listés dans le fichier [`requirements.txt`](https://github.com/qmk/qmk_firmware/blob/master/requirements.txt). - -# CLI globale - -QMK met à disposition une CLI installable qui peut être utilisée pour configurer votre environnement de compilation QMK, fonctionne avec QMK, et qui rend l'utilisation de plusieurs copies de `qmk_firmware` plus simple. Nous recommandons d'installer et de mettre à jour ceci régulièrement. - -## Installer en utilisant Homebrew (macOS, quelques Linux) - -Si vous avez installé [Homebrew](https://brew.sh) vous pouvez entrer ce qui suit et installer QMK: - -``` -brew tap qmk/qmk -brew install qmk -export QMK_HOME='~/qmk_firmware' # Optional, set the location for `qmk_firmware` -qmk setup # This will clone `qmk/qmk_firmware` and optionally set up your build environment -``` - -## Installer en utilisant easy_install ou pip - -Si votre système n'est pas listé ci-dessus, vous pouvez installer QMK manuellement. Premièrement, vérifiez que vous avez bien installé Python 3.5 (ou plus récent) et pip. Ensuite, installez QMK avec cette commande: - -``` -pip3 install qmk -export QMK_HOME='~/qmk_firmware' # Optional, set the location for `qmk_firmware` -qmk setup # This will clone `qmk/qmk_firmware` and optionally set up your build environment -``` - -## Paquets pour d'autres systèmes d'exploitation - -Nous recherchons des gens pour créer et maintenir un paquet `qmk` pour plus de systèmes d'exploitation. Si vous voulez créer un paquet pour votre système d'exploitation, suivez ces directives: - -* Suivez les bonnes pratiques pour votre système d'exploitation lorsqu'elles entrent en conflit avec ces directives - * Documentez pourquoi dans un commentaire lorsque vous ne les suivez pas -* Installez en utilisant un virtualenv -* Expliquez à l'utilisateur de définir la variable d'environnement `QMK_Home` pour "check out" les sources du firmware à un autre endroit que `~/qmk_firmware`. - -# CLI locale - -Si vous ne voulez pas utiliser la CLI globale, il y a une CLI locale empaquetée avec `qmk_firmware`. Vous pouvez le trouver dans `qmk_firmware/bin/qmk`. Vous pouvez lancer la commande `qmk` depuis n'importe quel répertoire et elle fonctionnera toujours sur cette copie de `qmk_firmware`. - -**Exemple**: - -``` -$ ~/qmk_firmware/bin/qmk hello -Ψ Hello, World! -``` - -## Limitations de la CLI locale - -Il y a quelques limitations à la CLI locale comparé à la globale: - -* La CLI locale ne supporte pas `qmk setup` ou `qmk clone` -* La CLI locale n'opère pas sur le même arbre `qmk_firmware`, même si vous avez plusieurs dépôts clonés. -* La CLI locale ne s'exécute pas dans un virtualenv, donc il y a des risques que des dépendances seront en conflit - -# Les commandes CLI - -## `qmk compile` - -Cette commande permet de compiler le firmware de n'importe quel répertoire. Vous pouvez compiler des exports JSON de ou compiler des keymaps du dépôt. - -**Utilisation pour les exports de configuration**: - -``` -qmk compile -``` - -**Utilisation pour les Keymaps**: - -``` -qmk compile -kb -km -``` - -## `qmk cformat` - -Cette commande formatte le code C en utilisant clang-format. Lancez-la sans arguments pour formatter tout le code core, ou passez les noms de fichiers à la ligne de commande pour la lancer sur des fichiers spécifiques. - -**Utilisation**: - -``` -qmk cformat [file1] [file2] [...] [fileN] -``` - -## `qmk config` - -Cette commande vous permet de configurer le comportement de QMK. Pour la documentation complète de `qmk config`, regardez [Configuration de CLI](cli_configuration.md). - -**Utilisation**: - -``` -qmk config [-ro] [config_token1] [config_token2] [...] [config_tokenN] -``` - -## `qmk doctor` - -Cette commande examine votre environnement et vous alertes des potentiels problèmes de compilation ou de flash. - -**Utilisation**: - -``` -qmk doctor -``` - -## `qmk new-keymap` - -Cette commande crée une nouvelle keymap basée sur une keymap par défaut d'un clavier existant. - -**Utilisation**: - -``` -qmk new-keymap [-kb KEYBOARD] [-km KEYMAP] -``` - -## `qmk pyformat` - -Cette commande formate le code python dans `qmk_firmware`. - -**Utilisation**: - -``` -qmk pyformat -``` - -## `qmk pytest` - -Cette commande démarre la suite de test python. Si vous faites des changements dans le code Python, assurez-vous que les tests se lancent avec succès. - -**Utilisation**: - -``` -qmk pytest -``` diff --git a/docs/fr-FR/cli_configuration.md b/docs/fr-FR/cli_configuration.md deleted file mode 100644 index 3eed1e0e95..0000000000 --- a/docs/fr-FR/cli_configuration.md +++ /dev/null @@ -1,121 +0,0 @@ -# Configuration de QMK CLI - -Ce document explique comment fonctionne la commande `qmk config`. - -# Introduction - -La configuration pour QMK CLI est un système clé/valeur. Chaque clé est composée d'une sous-commande et d'un argument séparé par une virgule. Cela permet une traduction simple et directe entre les clés de configuration et l'argument qu'elle définit. - -## Exemple simple - -Comme exemple, regardons la commande `qmk compile --keyboard clueboard/66/rev4 --keymap default`. - -Il y a deux arguments de ligne de commande qui peuvent être lu de la configuration: - -* `compile.keyboard` -* `compile.keymap` - -Essayons de les définir: - -```shell -$ qmk config compile.keyboard=clueboard/66/rev4 compile.keymap=default -compile.keyboard: None -> clueboard/66/rev4 -compile.keymap: None -> default -Ψ Wrote configuration to '/Users/example/Library/Application Support/qmk/qmk.ini' -``` - -Maintenant, je peux lancer la commande `qmk compile` sans avoir à spécifier mon clavier et keymap à chaque fois. - -## Définir les options par défaut - -Parfois, il est utile de partager une configuration entre plusieurs commandes. Par exemple, plusieurs commandes prennent un argument `--keyboard`. Plutôt que de devoir définir cette valeur pour chaque commande, vous pouvez définir une valeur d'utilisateur qui sera utilisée par toutes les commandes qui prennent cet argument. - -Exemple: - -``` -$ qmk config user.keyboard=clueboard/66/rev4 user.keymap=default -user.keyboard: None -> clueboard/66/rev4 -user.keymap: None -> default -Ψ Wrote configuration to '/Users/example/Library/Application Support/qmk/qmk.ini' -``` - -# CLI Documentation (`qmk config`) - -La commande `qmk config` est utilisée pour interagir avec la configuration sous-jacente. Lancée sans argument, elle affiche la configuration courante. Lorsque des arguments sont définis, ils sont considérés comme étant des jetons de configuration, qui sont des chaînes de caractère ne contenant aucun espace avec le format suivant: - - [.][=] - -## Définir des valeurs de configuration - -Vous pouvez définir des valeurs de configuration en mettant le caractère égal (=) dans votre clé de configuration. La clé doit toujours être dans le format complet `
.`. - -Exemple: - -``` -$ qmk config default.keymap=default -default.keymap: None -> default -Ψ Wrote configuration to '/Users/example/Library/Application Support/qmk/qmk.ini' -``` - -## Lire des valeurs de configuration - -Vous pouvez lire les valeurs de configuration pour la totalité de la configuration, une seule clé, ou une section entière. Vous pouvez aussi spécifier plusieurs clés pour afficher plus d'une valeur. - -### Exemple avec la totalité de la configuration - - qmk config - -### Exemple avec une section entière - - qmk config compile - -### Exemple avec une clé unique - - qmk config compile.keyboard - -### Exemple avec plusieurs clés - - qmk config user compile.keyboard compile.keymap - -## Supprimer des valeurs de configuration - -Vous pouvez supprimer une valeur de configuration en la définissant avec la chaîne spéciale `None`. - -Exemple: - -``` -$ qmk config default.keymap=None -default.keymap: default -> None -Ψ Wrote configuration to '/Users/example/Library/Application Support/qmk/qmk.ini' -``` - -## Plusieurs opérations - -Vous pouvez combiner plusieurs opérations d'écriture et de lecture en une seule commande. Elles seront exécutées et affichées dans l'ordre: - -``` -$ qmk config compile default.keymap=default compile.keymap=None -compile.keymap=skully -compile.keyboard=clueboard/66_hotswap/gen1 -default.keymap: None -> default -compile.keymap: skully -> None -Ψ Wrote configuration to '/Users/example/Library/Application Support/qmk/qmk.ini' -``` - -# Options de configuration utilisateur - -| Clé | Valeur par défaut | Description | -|-----|---------------|-------------| -| user.keyboard | None | Le chemin d'accès vers le clavier (Exemple: `clueboard/66/rev4`) | -| user.keymap | None | Le nom de la keymap (Exemple: `default`) | -| user.name | None | Le nom d'utilisateur GitHub de l'utilisateur. | - -# Toutes les options de configuration - -| Clé | Valeur par défaut | Description | -|-----|---------------|-------------| -| compile.keyboard | None | Le chemin d'accès vers le clavier (Exemple: `clueboard/66/rev4`) | -| compile.keymap | None | Le nom de la keymap (Exemple: `default`) | -| hello.name | None | Le nom à saluer lorsque démarré. | -| new_keyboard.keyboard | None | Le chemin d'accès vers le clavier (Exemple: `clueboard/66/rev4`) | -| new_keyboard.keymap | None | Le nom de la keymap (Example: `default`) | diff --git a/docs/fr-FR/contributing.md b/docs/fr-FR/contributing.md deleted file mode 100644 index 0092d664ef..0000000000 --- a/docs/fr-FR/contributing.md +++ /dev/null @@ -1,154 +0,0 @@ -# Comment contribuer - -👍🎉 Premièrement, merci de prendre le temps de lire ceci et de contribuer! 🎉👍 - -Les contributions de tiers nous aide à améliorer et faire grandir QMK. Nous voulons rendre les pull requests et le processus de contribution utile et simple à la fois pour les contributeurs et les mainteneurs. C'est pourquoi nous avons mis en places des directives pour les contributeurs afin que votre pull request puisse être accepté sans changement majeur. - -* [Aperçu du projet](#project-overview) -* [Conventions de codage](#coding-conventions) -* [Directives générales](#general-guidelines) -* [Que veut dire le code de conduite pour moi?](#what-does-the-code-of-conduct-mean-for-me) - -## Je ne veux pas lire tout ce pavé! J'ai juste une question! - -Si vous voulez poser une question sur QMK, vous pouvez le faire sur le [sous-reddit OLKB](https://reddit.com/r/olkb) ou sur [Discord](https://discord.gg/Uq7gcHh). - -Merci de garder ceci en tête: - -* Cela peut prendre plusieurs heures pour que quelqu'un réponde à votre question. Merci d'être patient! -* Tous ceux impliqués avec QMK fait don de son temps et de son énergie. Nous ne sommes pas payés pour travailler sur ou répondre aux questions concernant QMK. -* Essayez de poser vos questions de manière à ce qu'elles soient le plus simple à répondre possible. Si vous n'êtes pas sûrs de savoir comment faire, voici quelques bon guides (en anglais): - * https://opensource.com/life/16/10/how-ask-technical-questions - * http://www.catb.org/esr/faqs/smart-questions.html - -# Aperçu du projet - -QMK est majoritairement écrit en C, avec quelques fonctions et parties spécifiques écrites en C++. Il est destiné aux processeurs intégrés que l'on trouve dans des clavier, particulièrement AVR ([LUFA](http://www.fourwalledcubicle.com/LUFA.php)) et ARM ([ChibiOS](http://www.chibios.com)). Si vous maîtrisez déjà la programmation sur Arduino, vous trouverez beaucoup de concepts et de limitations familiers. Une expérience préalable avec les Arduino n'est pas nécessaire à contribuer avec succès à QMK. - - - -# Où trouver de l'aide? - -Si vous avez besoin d'aide, vous pouvez [ouvrir une issue](https://github.com/qmk/qmk_firmware/issues) ou [un chat sur Discord](https://discord.gg/Uq7gcHh). - -# Comment contribuer? - -Vous n'avez encore jamais contribué à un projet open source? Vous vous demandez comment les contributions dans QMK fonctionnent? Voici un aperçu rapide! - -0. Enregistrez-vous sur [GitHub](https://github.com). -1. Définissez une keymap à contribuer, [trouvez une issue](https://github.com/qmk/qmk_firmware/issues) que vous souhaitez corriger, ou [une fonction](https://github.com/qmk/qmk_firmware/issues?q=is%3Aopen+is%3Aissue+label%3Afeature) que vous voulez ajouter. -2. Créez un fork sur le dépôt associé avec une issue sur votre compte GitHub. Cela veut dire que vous allez avoir une copie du dépôt sous `votre-login-GitHub/qmk_firmware`. -3. Clonez le dépôt sur votre machine locale en utilisant `git clone https://github.com/login-github/repository-name.git`. -4. Si vous travaillez sur une nouvelle fonctionnalité, pensez à ouvrir une issue pour parler avec nous du travail que vous souhaitez démarrer. -5. Créez une nouvelle branche pour votre correctif en utilisant `git checkout -b nom-de-branche`. -6. Faites les changements nécessaires pour corriger le problème ou ajouter la fonctionnalité. -7. Utilisez `git add chemin-de-fichier` pour ajouter les contenus des fichiers modifiés au "snapshot" que git utilise pour gérer l'état du projet, appelé aussi l'index. -8. Utilisez `git commit -m "Insérez une description courte des changements (en anglais)"` pour enregistrer le contenu de l'index avec un message descriptif. -9. Poussez les changements vers votre dépôt sur GitHub en utilisant `git push origin nom-de-branche`. -10. Créez un pull request sur [QMK Firmware](https://github.com/qmk/qmk_firmware/pull/new/master). -11. Donnez un titre à votre pull request en utilisant une description courte des changements que vous avez fait et ajoutez le numéro de l'issue ou du bug associé avec votre changement. Les commentaires de PR devraient se faire en anglais de préférence. Par exemple, vous pouvez utiliser un titre tel que celui-là: "Added more log outputting to resolve #4352". -12. Dans la description du pull request, expliquez les changements que vous avez fait et tous les problèmes qui existent, selon vous, sur le pull request que vous avez fait. Vous pouvez aussi utiliser la description pour poser des questions au mainteneur. Il n'est pas nécessaire que votre pull request soit parfait (aucun pull request ne l'est), le reviewer sera là pour vous aider à résoudre les problèmes et l'améliorer! -13. Attendez que le pull request soit revu par un mainteneur. -14. Faites des changements au pull request si le mainteneur le recommande. -15. Célébrez votre succès une fois votre pull request fusionné! - -# Conventions de codage - -La grande majorité de notre style est plutôt simple à comprendre. Si vous connaissez C ou Python, vous ne devriez pas avoir trop de difficulté avec notre style. - -* [Conventions de codage - C](coding_conventions_c.md) -* [Conventions de codage - Python](coding_conventions_python.md) - -# Directives générales - -Nous avons un certain nombre de type de changements dans QMK, chacun nécessitant un niveau de rigueur différent. Nous voulons que vous gardiez les directives suivantes en tête quel que soit le changement que vous êtes en train de faire. - -* Séparez les PR dans des unités logiques. Par exemple, ne soumettez pas un PR qui couvre deux fonctionnalités séparées, soumettez plutôt un PR pour chaque fonctionnalité. -* Vérifiez les espaces blancs non nécessaires avec `git diff --check` avant de commit. -* Assurez-vous que votre code compile. - * Keymaps: Assurez-vous que `make keyboard:your_new_keymap` ne renvoie pas d'erreur. - * Claviers: Assurez-vous que `make keyboard:all` ne renvoie pas d'erreur. - * Core: Assurez-vous que `make all` ne renvoie pas d'erreur. -* Assurez-vous que les messages de commit soient compréhensibles d'eux-mêmes. Vous devriez écrire une description simple (pas plus de 70 caractères) sur la première ligne, suivi d'une ligne vide, suivi d'un détail de votre commit, si nécessaire. Exemple: - -``` -Adjust the fronzlebop for the kerpleplork - -The kerpleplork was intermittently failing with error code 23. The root cause was the fronzlebop setting, which causes the kerpleplork to activate every N iterations. - -Limited experimentation on the devices I have available shows that 7 is high enough to avoid confusing the kerpleplork, but I'd like to get some feedback from people with ARM devices to be sure. -``` - -## Documentation - -La documentation est l'une des manières les plus simples de démarrer la contribution sur QMK. Il est simple de trouver des endroits où la documentation est fausse ou incomplète, et il est tout aussi simple de la corriger! Nous avons aussi grandement besoin de quelqu'un pour éditer notre documentation, donc si vous avez des compétences en édition mais que vous n'êtes pas sûr de savoir où aller, n'hésitez pas [demandez de l'aide](#where-can-i-go-for-help)! - -Vous trouverez toute notre documentation dans le répertoire `qmk_firmware/docs`, ou si vous préférez utiliser des outils web, vous pouvez cliquer sur le bouton "Suggest An Edit" en haut de chaque page sur http://docs.qmk.fm/. - -Lorsque vous donnez des exemples de code dans la documentation, essayez de suivre les conventions de nommage utilisées ailleurs dans la documentation. Par exemple, standardisez les enums en utilisant `my_layers` ou `my_keycodes` afin de garder une consistance: - -```c -enum my_layers { - _FIRST_LAYER, - _SECOND_LAYER -}; - -enum my_keycodes { - FIRST_LAYER = SAFE_RANGE, - SECOND_LAYER -}; -``` - -## Keymaps - -La plupart des contributeurs débutants démarrent avec leurs keymaps personnelles. Nous essayons de garder les standards pour les keymaps pluôt simple (les keymaps reflètent, après tout, la personnalité de leurs créateurs) mais nous demandons que vous suiviez les directives suivantes afin que d'autres puissent découvrir et apprendre de votre keymap. - -* Ecrivez un fichier `readme.md` en utilisant [la template](documentation_templates.md). -* Tous les PR de keymaps doivent être "squashés", donc si la manière dont vos commits sont squashés vous est important, vous devez le faire vous-même. -* Ne regroupez pas des fonctionnalités avec votre PR de keymap. Envoyez d'abord votre fonctionnalité, puis créez un second PR pour la keymap. -* N'incluez pas de fichier `Makefile` dans votre dossier de keymap (ils ne sont plus utilisés) -* Mettez à jour les copyrights dans les en-têtes de fichiers (cherchez `%YOUR_NAME%`) - -## Claviers - -Les claviers sont la raison d'être de QMK. Certains claviers sont maintenus par la communauté, alors que d'autre sont maintenus par les gens responsables de la création du clavier. Le fichier `readme.md` devrait vous informer de qui maintient le clavier. Si vous avez des questions concernant un clavier en particulier, vous pouvez [Ouvrir une issue](https://github.com/qmk/qmk_firmware/issues) et tagger le mainteneur dans votre question. - -Nous vous demandons aussi que vous suiviez ces directives: - -* Ecrivez un fichier `readme.md` en utilisant [le template](documentation_templates.md). -* Gardez un nombre de commits raisonnable, ou nous squasherons votre PR. -* Ne regroupez pas des fonctionnalités avec le PR pour votre clavier. Envoyez d'abord votre fonctionnalité, puis créez un second PR pour le clavier. -* Appelez les fichiers `.c`/`.h` du nom du dossier parent, par exemple `/keyboards///.[ch]` -* N'incluez pas de fichier `Makefile` dans votre dossier de keymap (ils ne sont plus utilisés) -* Mettez à jour les copyrights dans les en-têtes de fichiers (cherchez `%YOUR_NAME%`) - -## Quantum/TMK Core - -Faites attention d'être sûr d'implémenter votre nouvelle fonctionnalité de la meilleure manière qu'il soit avant d'investir beaucoup de travail à son développement. Vous pouvez apprendre les bases de QMK en lisant [Comprendre QMK](understanding_qmk.md), qui vous donnera une idée du flux du programme QMK. A partir de là, parlez nous afin de définir la meilleure façon d'implémenter votre idée. Il y a deux façons principale de le faire: - -* [Chat sur Discord](https://discord.gg/Uq7gcHh) -* [Ouvrir une Issue](https://github.com/qmk/qmk_firmware/issues/new) - -Les PR de nouvelles fonctionnalités de de correction de bug affectent tous les claviers. Nous sommes aussi dans un processus de restructuration de QMK. Pour cette raison, il est absolument nécessaire que tout changement important ou significatif soit discuté avant que l'implémentation soit faite. Si vous ouvrez un PR sans nous avoir parlé, préparez-vous à faire des refontes significatives si vos changements ne sont pas compatibles avec ce que nous avons planifié. - -Voici quelques choses à garder en tête lorsque vous travaillez sur une fonctionnalité ou un bug fix. - -* **Désactivé par défaut** - la mémoire est plutôt limitée sur la plupart des puces que QMK supporte, et il est important que les keymaps courantes ne soient pas cassées. S'il vous plaît faites que vos features doivent être **activées** plutôt que désactivées. Si vous pensez qu'elle devrait être activée par défaut, ou que cela réduit la taille du code, parlez-nous-en. -* **Compilez localement avant de soumettre** - Cela devrait aller sans dire, mais votre code doit compiler! Notre système Travis devrait relever les problèmes, mais il est généralement plus rapide de compiler quelques claviers en local plutôt que d'attendre le retour des résultats -* **Faites attention aux révisions et différentes bases de puces** - beaucoup de claviers ont des révisions qui permettent des changements de configuration mineurs, voir des bases de chip différentes. Essayez de faire que votre fonctionnalité soit supportée à la fois sur ARM et AVR, ou désactivez-là automatiquement sur les plateformes non supportées. -* **Expliquez votre fonctionnalité** - Documentez-là dans `docs/`, soit dans un nouveau fichier, ou dans une partie d'un fichier existant. Si vous ne la documentez pas, personne ne pourra bénéficier de votre dur labeur. - -Nous vous demandons aussi de suivre ces directives: - -* Gardez un nombre de commits raisonnable, ou nous squasherons votre PR. -* Ne regroupez pas des claviers ou des keymaps avec des changements core. Soumettez vos changements core en premier. -* Ecrivez des [Tests Unitaires](unit_testing.md) pour votre fonctionnalité. -* Suivez le style du fichier que vous modifiez. Si le style n'est pas clair ou qu'il y a un mélange de fichiers, vous devriez vous conformer aux [conventions de codage](#coding-conventions) au dessus. - -## Refactoriser - -Afin de maintenir une vision claire sur comment les choses sont architectuées dans QMK, nous essayons de planifier des refactorisations en profondeur et qu'un collaborateur fasse le changement. Si vous avez une idée de refactorisation, ou une suggestion, [ouvrez une issue] [open an issue](https://github.com/qmk/qmk_firmware/issues), nous adorons discuter de comment améliorer QMK. - -# Que veut dire le code de conduite pour moi? - -Note [Code De Conduite](https://github.com/qmk/qmk_firmware/blob/master/CODE_OF_CONDUCT.md) veut dire que vous avez la responsabilité de traiter tout le monde dans le projet avec respect et courtoisie, peu importe leur identité. Si vous êtes victime d'une attitude ou de commentaires inappropriés, tels que décrit dans notre Code de Conduite, nous sommes là pour vous et nous ferons de notre mieux pour nous assurer que le fautif soit réprimandé, tel que décrit dans notre code. diff --git a/docs/fr-FR/flashing.md b/docs/fr-FR/flashing.md deleted file mode 100644 index c380614a5d..0000000000 --- a/docs/fr-FR/flashing.md +++ /dev/null @@ -1,239 +0,0 @@ -# Instructions pour flasher et informations sur les bootloader - -Les claviers utilisent différents types de bootloaders et certains doivent être flashés différement. Heureusement, certains projets comme la [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases) ont pour objectifs de permettre de flasher les différents bootloader sans trop se faire de soucis et ça peu importe les manières de les flasher. - -Si vous avez un bootloader sélectionné avec la variable `BOOTLOADER` dans votre fichier `rules.mk` alors QMK vas automatiquement calculer si votre fichier .hex n'est pas trop grand pour être flashé sur votre appareil, et il affichera la taille finale du firmware. Pour vérifier la taille manuellement, vous pouvez aussi compiler le firmware avec l'option `check-size`. Exemple : `make planck/rev4:default:check-size`. - -## DFU - -Le bootloader pour les processeurs Atmel DFU est fourni par défaut sur tous les processeurs atmega32u4. Celui-ci est utilisé par beaucoup de claviers plus vieux que les OLKB et Clueboard qui ont leur propre ICs sur leurs PCBs. D'autres claviers utilisent le bootloader DFU de LUFA (ou son fork QMK), notamment les nouveaux claviers OLKB. Ce dernier ajoute des fonctionnalités spécifiques sur le matériel. - -Pour vérifier la compatibilité avec le bootloader DFU, vérifiez que ce bloc de code est présent dans votre fichier `rules.mk`. Parfois il peut être inscrit `lufa-dfu` ou `qmk-dfu` à la place. - -```make -# Bootloader selection -# Teensy halfkay -# Pro Micro caterina -# Atmel DFU atmel-dfu -# LUFA DFU lufa-dfu -# QMK DFU qmk-dfu -# ATmega32A bootloadHID -# ATmega328P USBasp -BOOTLOADER = atmel-dfu -``` - -Méthodes de flash compatibles : - -* [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases) (interface graphique recommandé) -* [dfu-programmer](https://github.com/dfu-programmer/dfu-programmer) / `:dfu` avec QMK (outil en ligne de commande recommandé) -* [Atmel's Flip](http://www.microchip.com/developmenttools/productdetails.aspx?partno=flip) (non recommandé) - -Ordre des actions : - -1. Pressez le keycode `RESET`, ou appuyez sur le bouton physique RESET ou alors créez un contact entre RST et GND. -2. Attendez que l'OS detecte l'appareil. -3. Éffacez la mémoire, cela peut être fait automatiquement. -4. Flasher le fichier .hex. -5. Redémarrez l'appareil en mode « application », cela peut être fait automatiquement. - -Alternativement : - - make ::dfu - -### DFU QMK - -QMK a un fork du bootloader LUFA DFU qui vous permet de faire un simple scan de la matrice pour quitter le bootloader et retourner à l'application. En même temps que le flash se produira, il est possible de faire flasher un led ou de produire un son via un haut parleur. Pour activer ces fonctionnalités, vous pouvez utiliser ce bloc dans votre fichier `config.h` (La touche permettant de quitter le bootloader a besoin d'être reliée entre les ports définis en INPUT et OUTPUT ici): - - #define QMK_ESC_OUTPUT F1 // usually COL - #define QMK_ESC_INPUT D5 // usually ROW - #define QMK_LED E6 - #define QMK_SPEAKER C6 - -Le fabricant et le nom du produit proviennent de vos définitions dans fichier `config.h`, et la chaîne de caractère « bootloader » est ajoutée au nom du produit. - -Pour génerer le bootloader, utilisez la cible `bootloader`. Exemple : `make planck/rev4:default:bootloader`. - -Pour génerer un fichier .hex prêt pour la production qui contiendra tant l'application que le bootloader, utilisez la cible `production`. Exemple : `make planck/rev4:default:production`. - -### Commandes DFU - -Il y a plusieurs commandes DFU que vous pouvez utiliser pour flasher le firmware sur un appareil DFU. - -* `:dfu` - C'est l'option normale qui attend qu'un appareil DFU soit disponible et qui flashe le firmware dès que c'est le cas. La vérification sera faite toutes les 5 secondes. -* `:dfu-ee` - Cette option flash un fichier `.eep` à la place d'un fichier `.hex`. Ce cas est plutôt rare. -* `:dfu-split-left` - Cette option flashe le firmware normal comme avec l'option (`:dfu`). Mais cela aussi flash le coté gauche du fichier EEPROM pour les claviers scindés. _C'est l'option idéale pour un clavier scindé basé sur le Elite C_ -* `:dfu-split-right` - Cette option flashe le firmware normal comme avec l'option (`:dfu`). Mais cela aussi flash le coté droite du fichier EEPROM pour les claviers scindés. _C'est l'option idéale pour un clavier scindé basé sur le Elite C_ - -## Caterina - -Les cartes arduinos et leurs clones utilisent le [bootloader Caterina](https://github.com/arduino/ArduinoCore-avr/tree/master/bootloaders/caterina) (tous les claviers utilisant un Pro Micro, ou un clone). Ils utilisent aussi le protocole avr109 pour communiquer en virtuellement en série (serial en anglais). Les bootloaders comme le [A-Star](https://www.pololu.com/docs/0J61/9) sont basés sur Caterina. - -Pour vérifier la compatibilité avec un bootloader Caterina, vérifiez que ce bloc est présent dans votre fichier `rules.mk` : - -```make -# Bootloader selection -# Teensy halfkay -# Pro Micro caterina -# Atmel DFU atmel-dfu -# LUFA DFU lufa-dfu -# QMK DFU qmk-dfu -# ATmega32A bootloadHID -# ATmega328P USBasp -BOOTLOADER = caterina -``` - -Flashers compatibles : - -* [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases) (Interface graphique recommandée) -* [avrdude](http://www.nongnu.org/avrdude/) avec avr109 / `:avrdude` (Outil en ligne de commande recommandé) -* [AVRDUDESS](https://github.com/zkemble/AVRDUDESS) - -Séquence de flash :  - -1. Pressez la touche avec le keycode `RESET`, ou reliez les ports GND et RST. Vous n'avez que 7 secondes pour flasher une fois que l'opération a été faite. -2. Attendez que l'OS détecte l'appareil. -3. Flasher le fichier .hex. -4. Attendez que l'appareil redémarre automatiquement. - -ou, utilisez : - - make ::avrdude - -#### Commandes Caterina - -Il existe un certain nombre de commandes DFU que vous pouvez utiliser pour mettre à jour le firmware sur un périphérique DFU: - -* `: avrdude` - Il s’agit de l’option normale. Le script va attendre qu’un appareil Caterina soit disponible. Dès que c’est le cas, il flash le firmware. Il attendra de détecter un nouveau port COM pour le flasher. -* `: avrdude-loop` - Cela fonctionne de la même manière que`: avrdude`, mais une fois que chaque périphérique est flashé, il tentera de flasher à nouveau. Cela peut être utile pour flasher plusieurs claviers à la suite. _Cela implique de sortir manuellement de la boucle en appuyant sur Ctrl + C, Cmd + C ou un raccourci équivalent selon votre OS_ -* `: avrdude-split-left` - Cela fonctionne de la même manière que la fonction (`: avrdude`). Toutefois, cela permet aussi de flasher le coté gauche de l'EEPROM des claviers splittés / divisés. C'est donc la méthode recommandée pour les claviers splittés avec Pro Micro. -* `: avrdude-split-right` - Cela fonctionne de la même manière que la fonction (`: avrdude`). Toutefois, cela permet aussi de flasher le coté droite de l'EEPROM des claviers splittés / divisés. C'est donc la méthode recommandée pour les claviers splittés avec Pro Micro. - -## Halfkay - -Halfkay est un protocole ultra-simple développé par PJRC qui utilise HID et qui est fourni avec tous les Teensys après le modèle 2.0. - -Pour vérifier la compatibilité avec le booloader Halfkay, vérifiez que ce bloc est présent dans votre fichier `rules.mk` : - -```make -# Bootloader selection -# Teensy halfkay -# Pro Micro caterina -# Atmel DFU atmel-dfu -# LUFA DFU lufa-dfu -# QMK DFU qmk-dfu -# ATmega32A bootloadHID -# ATmega328P USBasp -BOOTLOADER = halfkay -``` - -Flasher compatibles : - -* [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases) (Interface graphique recomandée) -* [Teensy Loader](https://www.pjrc.com/teensy/loader.html) (petit utilitaire ultra simple) - [Teensy Loader en ligne de commande](https://www.pjrc.com/teensy/loader_cli.html) (Outil en ligne de commande recommandé) - -Séquence de flash : - -1. Pressez la touche du keycode `RESET`, ou reliez les ports RST et GND rapidement. Vous avez ensuite 7 secondes pour réaliser le flash. -2. Attendez que l'OS détecte l'appareil. -3. Flasher le fichier .hex. -4. Redémarrez l'appareil en mode « application ». Cela peut être fait automatiquement. - -## USBasploader - -USBasploader est un bootloader développé par matrixstorm. Il est utilisé sur des processeurs AVR non-USB comme le ATmega328P, qui fonctionne grâce à V-USB. - -Pour vérifier la compatibilité avec le booloader USBasploader, vérifiez que ce bloc est présent dans votre fichier `rules.mk` : - -```make -# Bootloader selection -# Teensy halfkay -# Pro Micro caterina -# Atmel DFU atmel-dfu -# LUFA DFU lufa-dfu -# QMK DFU qmk-dfu -# ATmega32A bootloadHID -# ATmega328P USBasp -BOOTLOADER = USBasp -``` - -Flashers compatibles : - -* [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases) (Interface graphique recommandé) -* [avrdude](http://www.nongnu.org/avrdude/) avec le programmeur `usbasp`. -* [AVRDUDESS](https://github.com/zkemble/AVRDUDESS) - -Séquence de flash : - -1. Pressez la touche du keycode `RESET`, ou reliez le port de boot pendant que RST et GND snt reliés. Cela doit être fait très rapidement. -2. Attendez que l'OS détecte l'appareil. -3. Flasher le fichier .hex. -4. Redémarrez l'appareil en mode « application ». Cela peut être fait automatiquement. - -## BootloadHID - -BootloadHID est un bootloader pour les microcontrôleurs AVR. L'utilitaire de téleversement ne demande pas de drivers au niveau du kernel et peut être lancé sans installer aucune DLLs. - -Pour vérifier la compatibilité avec le bootloader bootloadHID, vérifiez que ce bloc existe dans votre fichier `rules.mk` :  - -```make -# Bootloader selection -# Teensy halfkay -# Pro Micro caterina -# Atmel DFU atmel-dfu -# LUFA DFU lufa-dfu -# QMK DFU qmk-dfu -# ATmega32A bootloadHID -# ATmega328P USBasp -BOOTLOADER = bootloadHID -``` - -Utilitaires de flash compatibles : - -* [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash) (Utilitaire avec interface graphique recommandé) -* [bootloadhid Command Line](https://www.obdev.at/products/vusb/bootloadhid.html) / `:BootloadHID` avec QMK (utilitaire en ligne de commande recommandé) - -Séquence de flash - -1. Entrez dans le bootloader en utilisant l'une de ces méthodes : - * Pressez la touche du keycode `RESET` (Cela ne fonctionnera pas sur certains appareils). - * Verrouillez la touche « Salt » tout en branchant le clavier (Généralement ce principe est documenté dans le fichier readme du clavier) -2. Attendez que l'OS détecte l'appareil. -3. Flasher le fichier .hex. -4. Redémarrez l'appareil en mode « application ». Cela peut être fait automatiquement. - -Ou alors : - - make ::bootloadHID - -## STM32 - -Tous les processeurs STM32 contiennent un bootloader installé en usine qui ne peut pas être modifié ou supprimé. Certains processeurs STM32 ont des bootloaders qui ne peuvent pas être programmés par USB (ex : STM32F103) mais le processus reste le même. - -Pour le moment, aucune variable `BOOTLOADER` n'est nécessaire dans le fichier `rules.mk`. - -Flashers compatibles : - -* [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases) (interface graphique recommandé) -* [dfu-util](https://github.com/Stefan-Schmidt/dfu-util) / `:dfu-util` (utilitaire en ligne de commande recommandé) - -Séquence pour flasher: - -1. Entrez dans le bootloader en utilisant l'une de ces méthodes : - * Utilisez une touche sur laquelle le keycode `RESET` (Cela peut ne pas fonctionner sur les appareils STM32F042) - * Si un circuit de réinitialisation (Reset) est présent alors utilisé le bouton qui lui est dédié. - * Autrement, vous devez réaliser une liaison entre BOOT0 et VCC (en appuyant sur le bouton ou à l'aide d'un pont) puis faire un pont entre RESET et GND et enfin relacher le pont BOOT0. -2. Attendre que l'os détecte l'appareil. -3. Flasher un fichier `.bin`.h - * Vous allez recevoir un avertissement à propos de la signature DFU. Ignorez-la. -4. Réinitialisez l'appareil en mode « application ». Cela peut être fait automatiquement. - * Si vous êtes en train de travailler en ligne de commande, par exemple avec un `make planck/rev6:default:dfu-util` alors soyez bien sur que l'argument `:leave` est passé aux arguments DFU grâce à la variable `DFU_ARGS` à l'intérieur de votre fichier `rules.mk` (Ex : `DFU_ARGS = -d 0483:df11 -a 0 -s 0x08000000:leave`) afin que votre appareil redémarre après avoir été flashé. - -### Commandes STM32 - -Il y a différentes commandes que vous pouvez utiliser pour flasher un firmware dans un appareil STM32  : - -* `:dfu-util` - C'est l'option standard pour flasher un appareil STM32. Le script attendra qu'un bootloader STM32 soit présent. -* `:dfu-util-split-left` - Permet de flasher un firmware normalement, tout comme l'option précédente mais permet de configurer le côté gauche des paramètres EEPROM sur un clavier scindé. -* `:dfu-util-split-right` - Permet de flasher un firmware normalement, tout comme l'option précédente mais permet de configurer le côté droit des paramètres EEPROM sur un clavier scindé. -* `:st-link-cli` - Cela permet de flasher le firmware avec l'utilitaire en ligne de commande ST-LINK's plutôt que d'utiliser dfu-util. diff --git a/docs/fr-FR/getting_started_getting_help.md b/docs/fr-FR/getting_started_getting_help.md deleted file mode 100644 index fedb18c76c..0000000000 --- a/docs/fr-FR/getting_started_getting_help.md +++ /dev/null @@ -1,15 +0,0 @@ -# Trouver de l'aide - -Il y a beaucoup de ressources pour trouver de l'aide avec QMK. - -## Chat temps-réel - -Vous trouverez des développeurs QMK et des utilisateurs sur notre [Serveur Discord](https://discord.gg/Uq7gcHh) principal. Il y a des canaux spécifiques dans le serveur pour discuter des firmwares, toolbox, hardware et configurateurs. - -## Sous-Reddit OLKB - -Le forum officiel de QMK est [/r/olkb](https://reddit.com/r/olkb) sur [reddit.com](https://reddit.com). - -## Tickets GitHub - -Vous pouvez ouvrir un [ticket sur GitHub](https://github.com/qmk/qmk_firmware/issues). Ceci est spécialement pratique lorsque votre problème demande une discussion sur le long terme ou un débugage. diff --git a/docs/fr-FR/getting_started_github.md b/docs/fr-FR/getting_started_github.md deleted file mode 100644 index 22c6ee749b..0000000000 --- a/docs/fr-FR/getting_started_github.md +++ /dev/null @@ -1,61 +0,0 @@ -# Comment utiliser GitHub avec QMK - -GitHub peut être un peu compliqué pour ceux qui n'y sont pas familier. Ce guide va vous expliquer chaque étape de "fork", clone et envoi d'un pull request avec QMK. - -?> Ce guide part du principe que vous êtes suffisamment à l'aise pour envoyer commandes sur la ligne de commande et que vous avez Git installé sur votre système. - -Commencez par la [page GitHub de QMK](https://github.com/qmk/qmk_firmware), et vous verrez un bouton dans le coin en haut à droite qui indique "Fork": - -![Fork on Github](http://i.imgur.com/8Toomz4.jpg) - -Si vous faites partie d'une organisation, vous aurez besoin de savoir quel compte utiliser pour le fork. Dans la plupart des cas, vous voudrez créer le fork dans votre compte personnel. Une fois le fork complet (cela peut quelques fois prendre un peu de temps), appuyez sur le bouton "Clone or download": - -![Download from Github](http://i.imgur.com/N1NYcSz.jpg) - -Faites attention à sélectionner "HTTPS", et sélectionnez le lien et copiez-le: - -![HTTPS link](http://i.imgur.com/eGO0ohO.jpg) - -Ensuite, entrez `git clone` dans la ligne de commande, et collez votre lien: - -``` -user@computer:~$ git clone https://github.com/whoeveryouare/qmk_firmware.git -Cloning into 'qmk_firmware'... -remote: Counting objects: 46625, done. -remote: Compressing objects: 100% (2/2), done. -remote: Total 46625 (delta 0), reused 0 (delta 0), pack-reused 46623 -Receiving objects: 100% (46625/46625), 84.47 MiB | 3.14 MiB/s, done. -Resolving deltas: 100% (29362/29362), done. -Checking out files: 100% (2799/2799), done. -``` - -Vous avez maintenant votre fork QMK sur votre machine locale, vous pouvez ajouter votre keymap, la compiler et la flasher sur votre board. Une fois heureux avec vos changements, vous pouvez les ajouter, commit, et pousser vers votre fork comme suit: - -``` -user@computer:~$ git add . -user@computer:~$ git commit -m "adding my keymap" -[master cccb1608] adding my keymap - 1 file changed, 1 insertion(+) - create mode 100644 keyboards/planck/keymaps/mine/keymap.c -user@computer:~$ git push -Counting objects: 1, done. -Delta compression using up to 4 threads. -Compressing objects: 100% (1/1), done. -Writing objects: 100% (1/1), 1.64 KiB | 0 bytes/s, done. -Total 1 (delta 1), reused 0 (delta 0) -remote: Resolving deltas: 100% (1/1), completed with 1 local objects. -To https://github.com/whoeveryouare/qmk_firmware.git - + 20043e64...7da94ac5 master -> master -``` - -Vos changements existent maintenant dans votre fork sur GitHub. Si vous allez à cette adresse (`https://github.com//qmk_firmware`), vous pouvez créer un nouveau "Pull Request" en cliquant sur ce bouton: - -![New Pull Request](http://i.imgur.com/DxMHpJ8.jpg) - -Maintenant, vous pourrez voir exactement ce que vous avez commité. Si ça vous semble bien, vous pouvez le finaliser en cliquant sur "Create Pull Request": - -![Create Pull Request](http://i.imgur.com/Ojydlaj.jpg) - -Une fois transmis, nous pourrons vous parler de vos changements, vous demander de faire des changements, et éventuellement de les accepter! - -Merci de contribuer à QMK :) diff --git a/docs/fr-FR/getting_started_introduction.md b/docs/fr-FR/getting_started_introduction.md deleted file mode 100644 index a7f0ff96af..0000000000 --- a/docs/fr-FR/getting_started_introduction.md +++ /dev/null @@ -1,62 +0,0 @@ -# Introduction - -Le but de cette page est d'expliquer les informations de base qui vous serons nécessaire pour travailler sur le projet QMK. Il a pour pré-requis que vous soyez familier à la navigation à l'aide d'un shell Unix, mais ne s'attend pas à ce que vous soyez familier avec C ou la compilation en utilisant make. - -## Structure de base de QMK - -QMK est un fork du projet [tmk_keyboard](https://github.com/tmk/tmk_keyboard) créé par [Jun Wako](https://github.com/tmk). Le code originel de TMK, avec quelques modifications, se trouve dans le dossier `tmk`. Les additions que QMK amène au projet se trouvent dans le dossier `quantum`. Les projets de clavier se trouvent dans les dossiers `handwired` et `keyboard`. - -### Structure du Userspace - -Dans le dossier `users` se trouve un répertoire pour chaque utilisateur. C'est un endroit où les utilisateurs peuvent mettre du code qui serait partagé entre plusieurs claviers. Merci de lire la documentation [Fonctionnalité Userspace](feature_userspace.md) pour plus d'information. - -### Structure du projet clavier - -Dans le dossier `keyboards`, son sous-dossier `handwired` et ses sous-dossiers pour les revendeurs et fabriquants (p