docs/fr-fr/getting_started_introduction.md

   1 # Introduction
   2
   3 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.
   4
   5 ## Structure de base de QMK
   6
   7 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_core`. 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`.
   8
   9 ### Structure du Userspace
  10
  11 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.
  12
  13 ### Structure du projet clavier
  14
  15 Dans le dossier `keyboards`, son sous-dossier `handwired` et ses sous-dossiers pour les revendeurs et fabriquants (par exemple `clueboard`) se trouve un répertoire pour chaque projet clavier. Par exemple `qmk_firmware/keyboards/clueboard/2x1800`.
  16
  17 A l'intérieur, vous trouverez la structure suivante:
  18
  19 * `keymaps/`: différentes keymaps qui peuvent être compilées
  20 * `rules.mk`: Ce fichier définit les options "make" par défaut. Ne modifiez pas ce fichier directement, utilisez à la place un `rules.mk` spécifique à la keymap.
  21 * `config.h`: Ce fichier définit les options de compilation par défaut. Ne modifiez pas ce fichier directement, utilisez à la place un `config.h` spécifique à la keymap.
  22 * `info.json`: Le fichier utilisé pour définir les options de layout de QMK Configurator. Voyez [Support Configurator](reference_configurator_support.md) pour plus d'information.
  23 * `readme.md`: une brève description du clavier.
  24 * `<keyboardName>.h`: Ce fichier définit le layout du fichier par rapport à la matrice de commutation.
  25 * `<keyboardName>.c`: Ce fichier définit du code custom pour le clavier.
  26
  27 Pour plus d'information sur la structure du projet, voyez [Directives clavier QMK](hardware_keyboard_guidelines.md).
  28
  29 ### Structure d'une Keymap
  30
  31 Dans chaque dossier keymap, vous allez trouver les fichiers suivants. Seul le fichier `keymap.c` est nécessaire, et si le reste des fichiers n'existent pas, les options par défaut seront choisies.
  32
  33 * `config.h`: les options de configuration de votre keymap
  34 * `keymap.c`: tout le code de votre keymap, requis
  35 * `rules.mk`: les features de QMK qui sont activées
  36 * `readme.md`: une description de votre keymap, comment d'autres l'utiliseront, et des explications des fonctionnalités. Uploadez les images vers un service comme imgur.
  37
  38 # Le fichier `config.h`
  39
  40 Le fichier `config.h` peut être mis à 3 endroits:
  41
  42 * keyboard (`/keyboards/<keyboard>/config.h`)
  43 * userspace (`/users/<user>/config.h`)
  44 * keymap (`/keyboards/<keyboard>/keymaps/<keymap>/config.h`)
  45
  46 Le système de compilation cherche automatiquement les fichiers de configuration dans l'ordre au-dessus. Si vous souhaitez surcharger une configuration définie par un `config.h` précédent, vous devrez d'abord ajouter le code suivant.
  47
  48 ```
  49 #pragma once
  50 ```
  51
  52 Ensuite, pour surcharger l'option du fichier `config.h` précédent, vous devez `#undef` puis `#define` l'option à nouveau.
  53
  54 Voici à quoi l'ensemble du code ressemble une fois regroupé:
  55
  56 ```
  57 #pragma once
  58
  59 // overrides go here!
  60 #undef MY_SETTING
  61 #define MY_SETTING 4
  62 ```