forked from qmk/qmk_firmware
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Docs] French translation of QMK Basics (qmk#6925)
* Adds the files that will be translated * Start translate cli_configuration.md in French * Translated cli.md in French * Translated getting_started_getting_help.md in French * /getting_started_github.md * Translated first part of contributing.md in French * Finish translation of contributing.md * Translated the getting_started_introduction.md in French * Corrected issues from @zekth review Co-Authored-By: Vincent LE GOFF <g_n_s@hotmail.fr>
- Loading branch information
1 parent
532bb47
commit d6ef0f3
Showing
7 changed files
with
567 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,146 @@ | ||
# 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'intéraction avec les clavier QMK. Nous avons définis 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 <https://config.qmk.fm> ou compiler des keymaps du dépôt. | ||
|
||
**Utilisation pour les exports de configuration**: | ||
|
||
``` | ||
qmk compile <configuratorExport.json> | ||
``` | ||
|
||
**Utilisation pour les Keymaps**: | ||
|
||
``` | ||
qmk compile -kb <keyboard_name> -km <keymap_name> | ||
``` | ||
|
||
## `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 formatte 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 | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,121 @@ | ||
# 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 intéragir 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: | ||
|
||
<subcommand|general|default>[.<key>][=<value>] | ||
|
||
## 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 `<section>.<key>`. | ||
|
||
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 plusieures opérations d'écriture et de lecture en une seule commande. Elle 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`) | |
Oops, something went wrong.