aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoel Challis <git@zvecr.com>2022-01-05 02:11:24 +0000
committerGitHub <noreply@github.com>2022-01-04 18:11:24 -0800
commit1c1e6fa47df8d1dc094973929afdfd1ca9333150 (patch)
treebe5134db191f468f899d6c42ad5380c050ccc16c
parent550c9a315f146bc30fc828726d977f3f41477d52 (diff)
downloadqmk_firmware-1c1e6fa47df8d1dc094973929afdfd1ca9333150.tar.gz
qmk_firmware-1c1e6fa47df8d1dc094973929afdfd1ca9333150.zip
Remove stale docs translations (#15737)
-rw-r--r--book.json46
-rw-r--r--docs/_langs.md5
-rw-r--r--docs/de/README.md32
-rw-r--r--docs/de/_summary.md122
-rw-r--r--docs/de/cli.md150
-rw-r--r--docs/de/driver_installation_zadig.md47
-rw-r--r--docs/de/newbs.md22
-rw-r--r--docs/de/newbs_building_firmware.md78
-rw-r--r--docs/de/newbs_flashing.md369
-rw-r--r--docs/de/newbs_getting_started.md101
-rw-r--r--docs/de/newbs_learn_more_resources.md14
-rw-r--r--docs/de/newbs_testing_debugging.md102
-rw-r--r--docs/es/README.md31
-rw-r--r--docs/es/_summary.md122
-rw-r--r--docs/es/hardware.md8
-rw-r--r--docs/es/hardware_avr.md182
-rw-r--r--docs/es/hardware_drivers.md31
-rw-r--r--docs/es/hardware_keyboard_guidelines.md147
-rw-r--r--docs/es/newbs.md23
-rw-r--r--docs/es/newbs_best_practices.md159
-rw-r--r--docs/es/newbs_building_firmware.md81
-rw-r--r--docs/es/newbs_building_firmware_configurator.md105
-rw-r--r--docs/es/newbs_flashing.md351
-rw-r--r--docs/es/newbs_getting_started.md103
-rw-r--r--docs/es/newbs_learn_more_resources.md15
-rw-r--r--docs/es/newbs_testing_debugging.md101
-rw-r--r--docs/fr-fr/ChangeLog/20190830.md52
-rw-r--r--docs/fr-fr/README.md31
-rw-r--r--docs/fr-fr/_summary.md126
-rw-r--r--docs/fr-fr/breaking_changes.md106
-rw-r--r--docs/fr-fr/cli.md127
-rw-r--r--docs/fr-fr/cli_configuration.md121
-rw-r--r--docs/fr-fr/contributing.md154
-rw-r--r--docs/fr-fr/driver_installation_zadig.md46
-rw-r--r--docs/fr-fr/faq.md6
-rw-r--r--docs/fr-fr/faq_build.md154
-rw-r--r--docs/fr-fr/faq_debug.md153
-rw-r--r--docs/fr-fr/faq_general.md16
-rw-r--r--docs/fr-fr/faq_keymap.md161
-rw-r--r--docs/fr-fr/flashing.md238
-rw-r--r--docs/fr-fr/getting_started_getting_help.md15
-rw-r--r--docs/fr-fr/getting_started_github.md66
-rw-r--r--docs/fr-fr/getting_started_introduction.md62
-rw-r--r--docs/fr-fr/newbs.md23
-rw-r--r--docs/fr-fr/newbs_best_practices.md161
-rw-r--r--docs/fr-fr/newbs_building_firmware.md81
-rw-r--r--docs/fr-fr/newbs_building_firmware_configurator.md105
-rw-r--r--docs/fr-fr/newbs_flashing.md367
-rw-r--r--docs/fr-fr/newbs_getting_started.md101
-rw-r--r--docs/fr-fr/newbs_learn_more_resources.md14
-rw-r--r--docs/fr-fr/newbs_testing_debugging.md104
-rw-r--r--docs/he-il/README.md33
-rw-r--r--docs/he-il/_summary.md140
-rw-r--r--docs/he-il/documentation_best_practices.md67
-rw-r--r--docs/he-il/faq.md8
-rw-r--r--docs/he-il/faq_general.md17
-rw-r--r--docs/he-il/getting_started_getting_help.md17
-rw-r--r--docs/he-il/getting_started_github.md74
-rw-r--r--docs/he-il/getting_started_introduction.md72
-rw-r--r--docs/he-il/hardware.md10
-rw-r--r--docs/he-il/newbs_learn_more_resources.md16
-rw-r--r--docs/he-il/proton_c_conversion.md36
-rw-r--r--docs/he-il/quantum_keycodes.md25
-rw-r--r--docs/index.html23
-rw-r--r--docs/ko-kr/README.md32
-rw-r--r--docs/ko-kr/getting_started_build_tools.md156
-rw-r--r--docs/ko-kr/getting_started_getting_help.md17
-rw-r--r--docs/ko-kr/getting_started_github.md67
-rw-r--r--docs/pt-br/README.md30
-rw-r--r--docs/pt-br/_summary.md122
-rw-r--r--docs/ru-ru/README.md31
-rw-r--r--docs/ru-ru/_summary.md124
-rw-r--r--docs/ru-ru/getting_started_build_tools.md153
-rw-r--r--docs/ru-ru/getting_started_getting_help.md15
-rw-r--r--docs/ru-ru/getting_started_github.md63
-rw-r--r--docs/ru-ru/getting_started_introduction.md58
-rw-r--r--docs/ru-ru/newbs.md23
-rw-r--r--docs/ru-ru/newbs_getting_started.md102
78 files changed, 0 insertions, 6668 deletions
diff --git a/book.json b/book.json
deleted file mode 100644
index 79206bf35..000000000
--- a/book.json
+++ /dev/null
@@ -1,46 +0,0 @@
1{
2 "structure": {
3 "summary": "_summary.md"
4 },
5 "plugins" : [
6 "edit-link",
7 "forkmegithub",
8 "hints",
9 "page-toc",
10 "terminal",
11 "toolbar",
12 "bulk-redirect"
13 ],
14 "pluginsConfig": {
15 "edit-link": {
16 "base": "https://github.com/qmk/qmk_firmware/edit/master/docs",
17 "label": "Suggest an edit"
18 },
19 "forkmegithub": {
20 "color": "red",
21 "url": "https://github.com/qmk/qmk_firmware"
22 },
23 "page-toc": {
24 "selector": ".markdown-section h1, .markdown-section h2"
25 },
26 "terminal": {
27 "copyButtons": true,
28 "fade": false,
29 "style": "flat"
30 },
31 "toolbar": {
32 "buttons": [
33 {
34 "label": "QMK Firmware",
35 "icon": "fa fa-github",
36 "url": "https://github.com/qmk/qmk_firmware"
37 }
38 ]
39 },
40 "bulk-redirect": {
41 "basepath": "/",
42 "redirectsFile": "docs/redirects.json"
43 }
44 },
45 "root": "./docs/"
46}
diff --git a/docs/_langs.md b/docs/_langs.md
index e25458bbf..8b08c3451 100644
--- a/docs/_langs.md
+++ b/docs/_langs.md
@@ -1,9 +1,4 @@
1- Translations 1- Translations
2 - [:uk: English](/) 2 - [:uk: English](/)
3 - [:cn: 简体中文](/zh-cn/) 3 - [:cn: 简体中文](/zh-cn/)
4 - [:es: Español](/es/)
5 - [:fr: Français](/fr-fr/)
6 - [:israel: עברית](/he-il/)
7 - [:brazil: Português](/pt-br/)
8 - [:ru: Русский](/ru-ru/)
9 - [:jp: 日本語](/ja/) 4 - [:jp: 日本語](/ja/)
diff --git a/docs/de/README.md b/docs/de/README.md
deleted file mode 100644
index f5f35d9d1..000000000
--- a/docs/de/README.md
+++ /dev/null
@@ -1,32 +0,0 @@
1# Quantum Mechanical Keyboard Firmware
2
3[![Aktuelle Version](https://img.shields.io/github/tag/qmk/qmk_firmware.svg)](https://github.com/qmk/qmk_firmware/tags)
4[![Discord](https://img.shields.io/discord/440868230475677696.svg)](https://discord.gg/Uq7gcHh)
5[![Docs Status](https://img.shields.io/badge/docs-ready-orange.svg)](https://docs.qmk.fm)
6[![GitHub contributors](https://img.shields.io/github/contributors/qmk/qmk_firmware.svg)](https://github.com/qmk/qmk_firmware/pulse/monthly)
7[![GitHub forks](https://img.shields.io/github/forks/qmk/qmk_firmware.svg?style=social&label=Fork)](https://github.com/qmk/qmk_firmware/)
8
9## Was ist QMK Firmware?
10
11QMK (*Quantum Mechanical Keyboard*) ist eine Open-Source-Community, welche die QMK-Firmware, die QMK-Toolbox, [qmk.fm](https://qmk.fm) und diese Dokumententation betreut. QMK-Firmware ist eine Weiterentwicklung der [tmk\_keyboard](https://github.com/tmk/tmk_keyboard)-Tastatur-Firmware mit vielen nützlichen Zusatzfunktionen für Atmel AVR-Prozessoren. Ursprünglich wurde sie für Produkte von [OLKB](https://olkb.com), das [ErgoDox EZ](https://www.ergodox-ez.com) und das [Clueboard](https://clueboard.co/) entwickelt. Im Laufe der Zeit wurde sie mit Hilfe von [ChibiOS](https://chibios.org) auch für die ARM-Architektur angepasst. Außerdem ist es inzwischen möglich, auch handverdrahtete Tastaturen und selbst geätzte PCBs mit QMK zu verwenden.
12
13## Bezugsquelle für QMK
14
15Wenn Du vorhast, deine Tastatur, Tastaturbelegung oder Features zu QMK beizusteuern, geht das am einfachsten, indem Du das [Repository auf GitHub](https://github.com/qmk/qmk_firmware#fork-destination-box) forkst, die Änderungen in deinem lokalen Repo vornimmst und anschließend einen [Pull Request](https://github.com/qmk/qmk_firmware/pulls) einreichst.
16
17Ansonsten kannst Du es als [zip](https://github.com/qmk/qmk_firmware/zipball/master) oder [tar](https://github.com/qmk/qmk_firmware/tarball/master) herunterladen, oder es direkt via git klonen (`git clone git@github.com:qmk/qmk_firmware.git` bzw. `git clone https://github.com/qmk/qmk_firmware.git`).
18
19
20## Anleitung fürs Kompilieren
21
22Bevor Du in der Lage bist, die Firmware zu kompilieren, musst Du eine [Entwicklungsumgebung](de/getting_started_build_tools.md) für AVR und/oder ARM aufsetzen. Danach kannst Du mit dem `make` Befehl eine Keymap für deine Tastatur erzeugen. Die Notation dafür ist:
23
24 make planck/rev4:default
25
26Dies generiert die Revision `rev4` für eine Tastatur vom Type `planck` mit der `default` Tastaturbelegung. Nicht alle Tastaturen haben Revisionen (auch bekannt als Subprojekt oder Unterordner) weswegen dies auch ausgelassen werden kann:
27
28 make preonic:default
29
30## Möglichkeiten der Anpassung
31
32QMK hat viele [Features](de/features.md), die es zu entdecken gibt. In der [Dokumentation](https://docs.qmk.fmk) kannst Du Dir einen Überblick verschaffen. Die meisten Features basieren darauf, die [Tastaturbelegung](de/keymap.md) anzupassen und das Verhalten der [Keycodes](de/keycodes.md) zu verändern.
diff --git a/docs/de/_summary.md b/docs/de/_summary.md
deleted file mode 100644
index ffbd292bd..000000000
--- a/docs/de/_summary.md
+++ /dev/null
@@ -1,122 +0,0 @@
1* [Anleitung für Anfänger](de/newbs.md)
2 * [Erste Schritte](de/newbs_getting_started.md)
3 * [Die erste Firmware](de/newbs_building_firmware.md)
4 * [Firmware flashen](de/newbs_flashing.md)
5 * [Testen und Debuggen](de/newbs_testing_debugging.md)
6 * [Git Tips und Tricks](de/newbs_best_practices.md)
7 * [Hilfreiche Ressourcen](de/newbs_learn_more_resources.md)
8
9* [QMK Basics](de/README.md)
10 * [QMK Einführung](de/getting_started_introduction.md)
11 * [QMK CLI](de/cli.md)
12 * [QMK CLI Konfiguration](de/cli_configuration.md)
13 * [Zu QMK beitragen](de/contributing.md)
14 * [Anleitung für GitHub](de/getting_started_github.md)
15 * [Nach Hilfe fragen](de/getting_started_getting_help.md)
16
17* [Breaking Changes](de/breaking_changes.md)
18 * [2019 Aug 30](de/ChangeLog/20190830.md)
19
20* [FAQ](de/faq.md)
21 * [Häufige Fragen](de/faq_general.md)
22 * [Build/Kompilieren](de/faq_build.md)
23 * [Debugging/Troubleshooting](de/faq_debug.md)
24 * [Keymap](de/faq_keymap.md)
25 * [Treiber Installation mit Zadig](de/driver_installation_zadig.md)
26
27* Detailierte Guides
28 * [Build Tools installieren](de/getting_started_build_tools.md)
29 * [Vagrant Guide](de/getting_started_vagrant.md)
30 * [Build/Compile Anleitung](de/getting_started_make_guide.md)
31 * [Firmware flashen](de/flashing.md)
32 * [Funktionalität anpassen](de/custom_quantum_functions.md)
33 * [Keymap Überblick](de/keymap.md)
34
35* [Hardware](de/hardware.md)
36 * [AVR Prozessoren](de/hardware_avr.md)
37 * [Treiber](de/hardware_drivers.md)
38
39* Referenz
40 * [Tastatur Richtlinien](de/hardware_keyboard_guidelines.md)
41 * [Konfigurations Optionen](de/config_options.md)
42 * [Keycodes](de/keycodes.md)
43 * [Coding Konventionen - C](de/coding_conventions_c.md)
44 * [Coding Konventionen - Python](de/coding_conventions_python.md)
45 * [Dokumentations Best Practices](de/documentation_best_practices.md)
46 * [Dokumentations Templates](de/documentation_templates.md)
47 * [Glossar](de/reference_glossary.md)
48 * [Unit Testing](de/unit_testing.md)
49 * [Nützliche Funktionen](de/ref_functions.md)
50 * [Configurator Support](de/reference_configurator_support.md)
51 * [info.json Format](de/reference_info_json.md)
52 * [Python CLI Development](de/cli_development.md)
53
54* [Features](de/features.md)
55 * [Basic Keycodes](de/keycodes_basic.md)
56 * [US ANSI Shifted Keys](de/keycodes_us_ansi_shifted.md)
57 * [Quantum Keycodes](de/quantum_keycodes.md)
58 * [Advanced Keycodes](de/feature_advanced_keycodes.md)
59 * [Audio](de/feature_audio.md)
60 * [Auto Shift](de/feature_auto_shift.md)
61 * [Backlight](de/feature_backlight.md)
62 * [Bluetooth](de/feature_bluetooth.md)
63 * [Bootmagic](de/feature_bootmagic.md)
64 * [Combos](de/feature_combo.md)
65 * [Command](de/feature_command.md)
66 * [Debounce API](de/feature_debounce_type.md)
67 * [DIP Switch](de/feature_dip_switch.md)
68 * [Dynamic Macros](de/feature_dynamic_macros.md)
69 * [Encoders](de/feature_encoders.md)
70 * [Grave Escape](de/feature_grave_esc.md)
71 * [Haptic Feedback](de/feature_haptic_feedback.md)
72 * [HD44780 LCD Controller](de/feature_hd44780.md)
73 * [Key Lock](de/feature_key_lock.md)
74 * [Layouts](de/feature_layouts.md)
75 * [Leader Key](de/feature_leader_key.md)
76 * [LED Matrix](de/feature_led_matrix.md)
77 * [Macros](de/feature_macros.md)
78 * [Mouse Keys](de/feature_mouse_keys.md)
79 * [OLED Driver](de/feature_oled_driver.md)
80 * [One Shot Keys](de/one_shot_keys.md)
81 * [Pointing Device](de/feature_pointing_device.md)
82 * [PS/2 Mouse](de/feature_ps2_mouse.md)
83 * [RGB Lighting](de/feature_rgblight.md)
84 * [RGB Matrix](de/feature_rgb_matrix.md)
85 * [Space Cadet](de/feature_space_cadet.md)
86 * [Split Keyboard](de/feature_split_keyboard.md)
87 * [Stenography](de/feature_stenography.md)
88 * [Swap Hands](de/feature_swap_hands.md)
89 * [Tap Dance](de/feature_tap_dance.md)
90 * [Terminal](de/feature_terminal.md)
91 * [Thermal Printer](de/feature_thermal_printer.md)
92 * [Unicode](de/feature_unicode.md)
93 * [Userspace](de/feature_userspace.md)
94 * [Velocikey](de/feature_velocikey.md)
95
96* Für Maker und Modder
97 * [Hand Wiring Guide](de/hand_wire.md)
98 * [ISP Flashing Guide](de/isp_flashing_guide.md)
99 * [ARM Debugging Guide](de/arm_debugging.md)
100 * [I2C Driver](de/i2c_driver.md)
101 * [SPI Driver](de/spi_driver.md)
102 * [GPIO Controls](de/internals_gpio_control.md)
103 * [Proton C Conversion](de/proton_c_conversion.md)
104
105* Für ein tieferes Verständnis
106 * [Wie Tastaturen funktionieren](de/how_keyboards_work.md)
107 * [QMK verstehen](de/understanding_qmk.md)
108
109* Andere Themen
110 * [Eclipse mit QMK](de/other_eclipse.md)
111 * [VSCode mit QMK](de/other_vscode.md)
112 * [Support](de/getting_started_getting_help.md)
113 * [Übersetzungen](de/translating.md)
114
115* QMK Internals (In Progress)
116 * [Defines](de/internals_defines.md)
117 * [Input Callback Reg](de/internals_input_callback_reg.md)
118 * [Midi Device](de/internals_midi_device.md)
119 * [Midi Device Setup Process](de/internals_midi_device_setup_process.md)
120 * [Midi Util](de/internals_midi_util.md)
121 * [Send Functions](de/internals_send_functions.md)
122 * [Sysex Tools](de/internals_sysex_tools.md)
diff --git a/docs/de/cli.md b/docs/de/cli.md
deleted file mode 100644
index 259aeecf7..000000000
--- a/docs/de/cli.md
+++ /dev/null
@@ -1,150 +0,0 @@
1# QMK CLI (Kommandozeile)
2
3Diese Seite beschreibt die Einrichtung und den Umgang mit dem QMK CLI (Kommandozeile).
4
5# Übersicht
6
7Die QMK CLI vereinfacht das Zusammenbauen und Arbeiten mit QMK Tastaturen. Hier findest Du wichtige Befehle, um beispielsweise das Herunterladen und Kompilieren der QMK Firmware oder das Erstellen von Tastaturbelegungen (und vieles mehr) zu erleichtern.
8
9* [Globale CLI](#globale-cli)
10* [Lokale CLI](#lokale-cli)
11* [CLI-Befehle](#cli-befehle)
12
13# System-Anforderungen
14
15Die CLI benötigt Python 3.5 oder höher. Außerdem ist es nötig, die Packages laut [`requirements.txt`](https://github.com/qmk/qmk_firmware/blob/master/requirements.txt) zu installieren.
16
17# Globale CLI
18
19QMK bietet ein installierbares CLI, das Du zum Einrichten Deiner QMK Build-Umgebung verwenden kannst. Dieses ermöglicht Dir das Arbeiten mit QMK, und erleichtert das Arbeiten mit mehreren Kopien der `qmk_firmware`. Wir empfehlen, dieses CLI zu installieren und regelmäßig upzudaten.
20
21## Installation mit Homebrew (macOS, manche Linux)
22
23Solltest Du [Homebrew](https://brew.sh) installiert haben, kannst Du QMK per tap installieren:
24
25```
26brew tap qmk/qmk
27brew install qmk
28export QMK_HOME='~/qmk_firmware' # Optional: setzt den Installationsort für `qmk_firmware`
29qmk setup # Dies klont `qmk/qmk_firmware` und richtet optional auch Deine Build-Umgebung ein
30```
31
32## Installation mit easy_install oder pip
33
34Falls Du kein Homebrew hast, kannst Du QMK auch manuell installieren. Zuerst musst Du sicherstellen, dass Python 3.5 (oder höher) und pip installiert ist. Dann installiere QMK mit diesem Befehl:
35
36```
37pip3 install qmk
38export QMK_HOME='~/qmk_firmware' # Optional: setzt den Installationsort für `qmk_firmware`
39qmk setup # Dies klont `qmk/qmk_firmware` und richtet optional auch Deine Build-Umgebung ein
40```
41## Installation mit git Repo
42
43`git clone https://github.com/qmk/qmk_cli.git && cd qmk_cli && python3 setup.py install`
44
45## Packaging für andere Betriebssysteme
46
47Wir suchen nach Freiwilligen, die ein `qmk`-Package für weitere Betriebssysteme erstellen und pflegen. Falls Du ein Package für Dein OS erstellen möchtest, bitte befolge diese Richtlinien:
48
49* Verwende "Best Practices" für Dein OS, sollten sie mit diesen Richtlinien in Konflikt stehen.
50 * Dokumentiere den Grund in einem Kommentar, wenn Du abweichen musstest.
51* Installiere mit einem [virtualenv](https://virtualenv.pypa.io/en/latest/).
52* Weise den User an, die Umgebungs-Variable `QMK_HOME` zu setzen, um die Firmware-Quelle anders einzustellen als `~/qmk_firmware`.
53
54# CLI-Befehle
55
56## `qmk compile`
57
58Dieser Befehl erlaubt es dir, die Firmware - aus egal welchem Datei-Verzeichnis - zu compilen. Du kannst JSON-Exporte von <https://config.qmk.fm> oder Keymaps in der Repo kompilen.
59
60**Anwendung für Konfigurations-Exports**:
61
62```
63qmk compile <configuratorExport.json>
64```
65
66**Anwendung für Keymaps**:
67
68```
69qmk compile -kb <keyboard_name> -km <keymap_name>
70```
71
72## `qmk format-c`
73
74Dieser Befehl formatiert C-Code im clang-Format. Benutze ihn ohne Argumente, um den core-Code zu formatieren, oder benutze Namen von Dateien in der CLI, um den Befehl auf bestimmte Dateien anzuwenden.
75
76**Anwendung**:
77
78```
79qmk format-c [file1] [file2] [...] [fileN]
80```
81
82## `qmk config`
83
84Dieser Befehl konfiguriert das Verhalten von QMK. Für die volle `qmk config`-Dokumentation gehe zu [CLI-Konfiguration](cli_configuration.md).
85
86**Anwendung**:
87
88```
89qmk config [-ro] [config_token1] [config_token2] [...] [config_tokenN]
90```
91
92## `qmk docs`
93
94Dieser Befehl startet einen lokalen HTTP-Server, den Du zum Browsen oder Verbessern der Dokumentation verwenden kannst. Der Default-Port ist 8936.
95
96**Anwendung**:
97
98```
99qmk docs [-p PORT]
100```
101
102## `qmk doctor`
103
104Dieser Befehl untersucht Deine Umgebung und warnt Dich vor potentiellen Build- oder Flash-Problemen.
105
106**Anwendung**:
107
108```
109qmk doctor
110```
111
112## `qmk list-keyboards`
113
114Dieser Befehl listet alle zurzeit in `qmk_firmware` definierten Tastaturen/Keyboards auf.
115
116**Anwendung**:
117
118```
119qmk list-keyboards
120```
121
122## `qmk new-keymap`
123
124Dieser Befehl erstellt eine neue Keymap basierend auf einer existierenden Standard-Keymap eines bestimmten Keyboards.
125
126**Anwendung**:
127
128```
129qmk new-keymap [-kb KEYBOARD] [-km KEYMAP]
130```
131
132## `qmk format-py`
133
134Dieser Befehl formatiert Python-Code in `qmk_firmware`.
135
136**Anwendung**:
137
138```
139qmk format-py
140```
141
142## `qmk pytest`
143
144Dieser Befehl führt die Python Test Suite aus. Wenn Du Python-Code veränderst, solltest Du sicherstellen, dass der Test erfolgreich ausgeführt wurde.
145
146**Anwendung**:
147
148```
149qmk pytest
150```
diff --git a/docs/de/driver_installation_zadig.md b/docs/de/driver_installation_zadig.md
deleted file mode 100644
index bd04e0543..000000000
--- a/docs/de/driver_installation_zadig.md
+++ /dev/null
@@ -1,47 +0,0 @@
1# Bootloader Treiber Installation mit Zadig
2
3QMK erscheint für den Host als normales HID Eingabegerät und benötigt deshalb keine zusätzlichen Treiber. Der Bootloader, den Du für das Flashen der Firmware benötigst, jedoch meistens schon.
4
5Hierzu gibt es zwei Ausnahmen: den Caterina Bootloader, meistens auf Pro Micros, sowie den HalfKay Bootloader auf PJRC Teensys. Diese erscheinen als serieller Port und als generisches HID Gerät und benötigen keine Treiber.
6
7Wir empfehlen deshalb [Zadig](https://zadig.akeo.ie/). Wenn Du die Entwicklungsumgebung mit MSYS2 oder WSL installiert hast, wird dich dass `qmk_install.sh` Skript gefragt haben, ob es die Treiber für dich installieren sollte.
8
9## Installation
10
11Versetze deine Tastatur in den Bootloader-Modus, entweder durch Betätigung des physischen `RESET` Schalters - meist auf der Unterseite der Platine - oder durch das Auslösen des Key-Codes `RESET` bzw. `KC_RESET` (sollte in der zur Tastatur gehörigen `keycode.c` zu entnehmen sein). Sollte deine Tastatur weder noch besitzen, versuche es damit die `Escape`-Taste oder `Leertaste + B` zu halten während Du die Tastatur mit dem PC verbindest (Siehe auch [Bootmagic](de/feature_bootmagic.md) für weitere Details). Ein paar Tastaturen benutzen das [Command](de/feature_command.md)-Feature an Stelle von Bootmagic; in diesem Fall kannst du mit den Tastenkombinationen `linkes Shift + rechtes Shift + B` oder `linkes Shift + rechtes Shift + Escape` zu jeder Zeit in den Bootloader wechseln solange die Tastatur verbunden ist.
12
13Eingie Tastaturen haben u.U. spezielle Anweisungen um in den Bootloader-Modus zu gelangen. Zum Beispiel kann die [Bootmagic-Lite](de/feature_bootmagic.md#bootmagic-lite)-Taste (default: Escape) auf eine andere Taste gemappt sein; oder die magische Kombination (default: linkes Shift+rechtes Shift) verwendet anstatt Shift die STRG-Tasten. Die zur Tastatur gehörige README sollte dir Aufschluss darüber geben wie der Bootloader-Modus ausgelöst werden kann wenn Du unsicher bist.
14
15Um ein Gerät mit USBaspLoader in den Bootloader-Modus zu versetzen, halte `BOOT` gedrückt während Du den `RESET`-Knopf drückst.
16Alternativ, halte `BOOT` gedrückt während Du das USB-Kabel einsteckst.
17
18Zadig sollte das Bootloader-Gerät automatisch erkennen. Manchmal musst Du zusätzlich noch **Options → List All Devices** auswählen.
19
20 - Tastaturen mit Atmel AVR MCUs sollten als `ATm32U4DFU` (oder ähnlich) angezeigt werden, mit der Vendor ID `03EB`.
21 - USBasp werden als `USBasp` angezeigt, mit VID/PID `16C0:05DC`.
22 - Tastaturen AVR controller und dem QMK-DFU Bootloader haben den namen `<Tastatur Name> Bootloader` und die VID `03EB`.
23 - Die meisten ARM Tastaturen werden als `STM32 BOOTLOADER` angezeigt, mit VID/PID `0483:DF11`.
24
25!> Sollte Zadig ein oder mehrere Geräte mit `HidUsb`-Treiber anzeigen, dann ist deine Tastatur wahrscheinlich nicht im Bootloader-Modus. Der Pfeil wird orange eingefärbt sein und Du wirst nach einer Bestätigung gefragt um Veränderungen am System vorzunehmen. In diesem Fall **fahre nicht fort**!
26
27Wenn der Pfeil grün angezeigt wird, wähle den Treiber aus und klicke auf **Treiber installieren**. Der `libusb-win32`-Treiber sollte gewöhnlich für AVR verwendet werden und `WinUSB` für ARM. Sollte es danach noch nicht möglich sein die Tastatur zu flashen, versuche es mit einem anderen Treiber. Für USBaspLoader Geräte, die über die Befehlszeile mit MSYS2 geflasht werden, wird der `libusbk`-Treiber empfohlen. Ansonsten sollte `libusb-win32` funktionieren wenn die QMK Toolbox verwendet wird.
28
29![Zadig mit Bootloader-Treiber korrekt installiert](https://i.imgur.com/b8VgXzx.png)
30
31Entferne nun deine Tastatur und verbinde sie erneut um sicherzugehen dass der neue Treiber erfolgreich installiert wurde. Wenn Du QMK Toolbox benutzt, starte die Anwendung zur Sicherheit einmal neu, da Veränderungen am Treiber manchmal nicht richtig erkannt werden. Wenn dies immer noch nicht erfolgreich war hilft es an dieser Stelle manchmal ein Neustart des Computers.
32
33## Wiederherstellung einer Installation für ein falsches Gerät
34
35Wenn Du feststellst dass Du anschließend auf deiner Tastatur nicht mehr tippen kannst, ist etwas bei der Installation schief gelaufen. Ein häufiger Fehler ist es dass die Tastatur nicht im Bootloader-Modus war und stattdessen der Treiber für das HID-Gerät ersetzt wurde. Dies kannst Du einfach mit Zadig überprüfen, eine funktionierende Tastatur verwendet als Treiber `HidUsb` auf allen Interfaces .
36
37![Eine funktionierende Tastatur aus Zadigs Sicht](https://i.imgur.com/Hx0E5kC.png)
38
39Öffne den Geräte-Manager und suche nach einem Gerät das wie deine Tastatur aussieht.
40
41![Die Tastatur mit dem falschen Treiber installiert, im Geräte-Manager](https://i.imgur.com/L3wvX8f.png)
42
43Rechtsklick und **Gerät deinstallieren** anklicken. Bitte gehe sicher dass in diesem Schritt auch **Treibersoftware für dieses Gerät löschen** markiert ist.
44
45![Der "Gerät deinstallieren"-Dialog, mit "Treibersoftware für dieses Gerät entfernen" markiert](https://i.imgur.com/aEs2RuA.png)
46
47Klick **Aktion → Suche nach veränderter Hardware**. Nun solltest Du wieder in der Lage sein normal zu tippen. Vergewissere dich mit Hilfe von Zadig dass die Tastatur nun `HidUsb` als Treiber verwendet. Wenn dies der Fall ist sollte wieder alles funktionieren.
diff --git a/docs/de/newbs.md b/docs/de/newbs.md
deleted file mode 100644
index 61139a99e..000000000
--- a/docs/de/newbs.md
+++ /dev/null
@@ -1,22 +0,0 @@
1# Anleitung für absolute Beginner
2QMK ist eine mächtige Open Source Firmware für mechanische Tastaturen. Mit QMK kannst Du deine Tastatur sowohl sehr einfach als auch sehr umfangreich anpassen. Menschen unterschiedlichen Wissensstandes - vom kompletten Anfänger bis zum erfahrenen Programmierer - haben ihre Tastaturen mit QMK erfolgreich auf ihre persönlichen Bedürfnisse angepasst. Diese Anleitung soll Dir unabhängig von deinen Vorkenntnissen dabei helfen dies ebenfalls zu bewältigen.
3
4Bist Du unsicher ob deine Tastatur QMK unterstützt? Wenn es eine mechanische Tastatur ist, die Du selbst gebaut hast, stehen deine Chancen gut. Wir unterstützen eine [Vielzahl](https://qmk.fm/keyboards/) selbst gebauter Tastaturen, sodass selbst wenn deine jetzige Tastatur nicht unterstützt wird Du keine Probleme haben solltest eine für deine Anforderungen zu finden.
5
6## Übersicht
7
8Diese Anleitung ist in 7 Abschnitte unterteilt:
9
10* [Die ersten Schritte](newbs_getting_started.md)
11* [Die erste Firmware auf der Kommandozeile erzeugen](newbs_building_firmware.md)
12* [Die erste Firmware mit der Online GUI erzeugen](newbs_building_firmware_configurator.md)
13* [Firmware flashen](newbs_flashing.md)
14* [Testen und Debuggen](newbs_testing_debugging.md)
15* [Git Leitfaden](newbs_best_practices.md)
16* [Weitere hilfreiche Ressourcen für Anfänger](newbs_learn_more_resources.md)
17
18Diese Anleitung richtet sich an Personen, die vorher noch nie Software kompiliert haben. Die Entscheidungen und Empfehlungen basieren auf dieser Grundannahme. Es gibt unterschiedliche Herangehensweisen für viele der Prozeduren und wir unterstützen die meisten Alternativen. Wenn Du mal nicht weiter weißt oder Dir nicht sicher bist, wie Du an ein Problem herangehen sollst, kannst Du uns gerne [um Hilfe bitten](getting_started_getting_help.md).
19
20## Weitere Ressourcen
21
22* [Thomas Baart's QMK Basics Blog](https://thomasbaart.nl/category/mechanical-keyboards/firmware/qmk/qmk-basics/) – Ein äußerst hilfreicher Blog eines Community-Mitglieds, der einige Grundlagen der QMK-Firmware aus der Sicht des Benutzers erklärt (auf Englisch).
diff --git a/docs/de/newbs_building_firmware.md b/docs/de/newbs_building_firmware.md
deleted file mode 100644
index b6d484024..000000000
--- a/docs/de/newbs_building_firmware.md
+++ /dev/null
@@ -1,78 +0,0 @@
1# Eine eigene Firmware erstellen
2
3Nachdem Du nun eine funktionierende Entwicklungsumgebung aufgesetzt hast, bist Du nun bereit, deine eigene Firmware zu erstellen. Dieses Sektion des Guides wird zwischen drei Programmen hin- und herwechseln: deinem Dateimanager, deinem Texteditor und der Befehlszeile. Lasse diese drei Fenster geöffnet, bis Du fertig und zufrieden mit deiner Tastatur-Firmware bist.
4
5Solltest Du die Befehlszeile zwischenzeitlich geschlossen haben, vergiss nicht wieder in das richtige Verzeichnis zu navigieren, benutze dazu den Befehl `cd qmk_firmware`.
6
7## Navigiere in deinen Keymap Ordner
8
9Beginne damit, in das `keymaps` Verzeichnis für deine Tastatur zu navigieren.
10
11Wenn Du macOS oder Windows benutzt, kannst Du einfach in das keymaps Verzeichnis wechseln.
12
13?> macOS:<br>
14 open keyboards/<keyboard_folder>/keymaps
15
16?> Windows:<br>
17 start .\\keyboards\\<keyboard_folder>\\keymaps
18
19## Eine Kopie der `default` Tastaturbelegung erstellen
20
21Wenn Du den `keymaps` Ordner geöffnet hast, solltest Du zuerst eine Kopie des `default` Verzeichnisses erstellen. Wir empfehlen dafür deinen GitHub Benutzernamen zu verweden, aber Du kannst auch jeden anderen Namen verwenden solange er nur aus Kleinbuchstaben, Zahlen und Unterstrichen besteht.
22
23Um den Prozess zu automatisieren kannst Du dazu auch das Skript `new_keymap.sh` verwenden.
24
25Navigiere dazu in das `qmk_firmware/util` Verzeichnis und gib folgenden Befehl ein:
26
27```
28./new_keymap.sh <keyboard path> <username>
29```
30
31Um zum Beispiel den Benutzernamen John für die Tastaturbelegung eines 1up60hse zu verwenden, würdest Du Folgendes eingeben:
32
33```
34./new_keymap.sh 1upkeyboards/1up60hse john
35```
36
37## Öffne `keymap.c` in deinem bevorzugtem Text Editor
38
39Öffne deine `keymap.c`. In dieser Datei findest Du die Strukturen, die das Verhalten deiner Tastatur bestimmen. Oben in der `keymap.c` befinden sich Definitionen (defines) und Aufzählungen (enums), die die Tastaturbelegung leserlicher machen sollen. Weiter unten wirst Du eine Zeile finden, die wie folgt aussieht:
40
41 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
42
43Diese Zeile markiert den Anfang der Liste der Ebenen (Layers). Darunter befinden sich Zeilen die entweder `LAYOUT` oder `KEYMAP` enthalten, das deutet auf den Start einer Ebene hin. Danach folgt eine Liste von Tasten, die dieser Ebene zugewiesen sind.
44
45!> Beim Bearbeiten einer Tastaturbelegung solltest Du darauf achten, keine Kommata hinzuzufügen oder zu entfernen. Ansonsten kann dies dazu führen, dass deine Firmware nicht mehr kompiliert und es ist nicht immer einfach festzustellen, wo genau ein Komma zuviel oder zu wenig ist. Die letzte Zeile hat am Ende kein Komma, die Zeilen davor jedoch schon.
46
47## Personalisiere die Tastaturbelegung nach deinen Wünschen
48
49Wie Du diesen Schritt abschließt ist vollkommen Dir überlassen. Ändere die eine Sache die Dich stört oder verändere alles von Grund auf. Du kannst Ebenen entfernen die Du nicht brauchst oder Neue hinzufügen, bis zu 32 Stück. Die folgende Dokumentation verrät Dir was Du hier alles definieren kannst:
50
51* [Keycodes](de/keycodes.md)
52* [Features](de/features.md)
53* [FAQ](de/faq.md)
54
55?> Während Du langsam ein Gefühl dafür kriegst wie Keymaps funktionieren, solltest Du darauf achten nicht zuviel auf einmal zu verändern. Größere Änderungen machen es schwieriger, Probleme zu debuggen.
56
57## Deine Firmware erzeugen
58
59Wenn Du damit fertig bist, deine Tastaturbelegung anzupassen, musst Du noch die Firmware erzeugen. Öffne dazu wieder die Befehlszeile und führe folgenden Befehl aus:
60
61 make <my_keyboard>:<my_keymap>
62
63Wenn deine Tastaturbelegung z.B. "xyverz" heißt und Du die Belegung für ein rev5 planck erzeugen möchtest, lautet der Befehl:
64
65 make planck/rev5:xyverz
66
67Während des Kompiliervorgangs wird viel Text auf dem Bildschirm ausgegeben. Es sollte am Ende mit etwas enden das ungefähr so aussieht:
68
69```
70Linking: .build/planck_rev5_xyverz.elf [OK]
71Creating load file for flashing: .build/planck_rev5_xyverz.hex [OK]
72Copying planck_rev5_xyverz.hex to qmk_firmware folder [OK]
73Checking file size of planck_rev5_xyverz.hex [OK]
74 * File size is fine - 18392/28672
75```
76
77## Deine Firmware flashen
78Bitte fahre mit [Firmware flashen](de/newbs_flashing.md) fort, um zu erfahren, wie Du deine neue Firmware auf deine Tastatur flashen kannst.
diff --git a/docs/de/newbs_flashing.md b/docs/de/newbs_flashing.md
deleted file mode 100644
index 940438669..000000000
--- a/docs/de/newbs_flashing.md
+++ /dev/null
@@ -1,369 +0,0 @@
1# Deine Tastatur flashen
2
3Nachdem deine Firmware nun fertig ist musst Du Sie noch auf deine Tastatur flashen.
4
5## Flash-Vorgang mit QMK Toolbox
6
7Der einfachste Weg deine Tastatur zu flashen ist mit Hilfe der [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases)
8
9Leider ist die QMK Toolbox derzeit nur für Windows und macOS verfügbar. Wenn Du Linux benutzt (oder es vorziehst die Firmware mit der Kommandozeile zu flashen) solltest Du die Methode benutzen die [hier](de/newbs_flashing.md#tastatur-mit-der-befehlszeile-flashen) beschrieben wird.
10
11### Lade die Datei in QMK Toolbox
12
13Beginne damit die Datei in der QMK Toolbox Anwendung zu laden. Versichere dich dass Du die Firmware-Datei im Finder oder Explorer findest. Deine Tastatur-Firmware sollte entweder vom Typ `.hex` oder `.bin` sein sein. QMK sollte die für deine Tastatur entsprechende Datei automatisch in das Root-Verzeichnis (normalerweise `qmk_firmware`) kopieren.
14
15?> Wenn Du Windows oder macOS benutzt kannst Du mit folgenden Befehlen ganz einfach das aktuelle Firmware-Verzeichnis im Explorer oder Finder öffnen.
16
17#### Windows:
18
19``` start . ```
20
21#### macOS:
22
23``` open . ```
24
25Die Firmware-Dateien folgen dabei immer folgendem Schema:
26
27 <meine_Tastatur>_<meine_Tastaturbelegung>.{bin,hex}
28
29Zum Beispiel würde ein `planck/rev5` mit der `default` Tastaturbelegung folgenden Dateinamen haben:
30
31 planck_rev5_default.hex
32
33Wenn Du die Firmware-Datei gefunden hast kannst Du sie in das "Local file" ("Lokale Datei") Feld in der QMK Toolbox ziehen, alternativ kannst Du auf "Öffnen" klicken und in das Verzeichnis navigieren indem sich die Firmware-Datei befindet.
34
35### Die Tastatur in den DFU (Bootloader) Modus versetzen
36
37Um deine angepasste Firmware auf deine Tastatur zu flashen musst Du diese erst in einen speziellen "flashing"-Modus versetzen. Während die Tastatur in diesem Modus ist kannst Du nicht auf ihr tippen oder sie wie gewohnt als Tastatur benutzen. Es ist wichtig dass der flashing-Prozesses nicht unterbrochen oder die Tastatur ausstöpselst wird, da der Vorgang ansonst wiederholt werden muss.
38
39Verschiedene Tastaturen verwenden unterschiedliche Methoden um in den Bootloader-Modus zu gelangen. Wenn dein PCB im Moment QMK oder TMK verwendet und Du keine spezifischen Anweisungen erhalten hast probiere die folgenden Methoden in dieser Reihenfolge:
40
41* Halte beide Shift-Tasten und drücke `Pause`
42* Halte beide Shift-Tasten und drücke `B`
43* Entferne deine Tastatur vom Computer, drücke gleichzeitig `Leertaste` und `B`, verbinde die Tastatur wieder mit dem Computer und warte eine Sekunde bevor Du die Tasten wieder loslässt.
44* Drücke den physischen `RESET`-Knopf auf der Unterseite des PCBs
45* Suche auf dem PCB den Pin mit dem Label `RESET`, verbinde diesen mit deinem GND-Pin
46* Suche auf dem PCB den Pin mit dem Label `BOOT0`, verbinde diesen mit GND und schließe die Tastatur wieder an den PC an TODO: DIS IS DANGEROUS!!
47
48Wenn Du damit erfolgreich warst solltest Du in der QMK Toolbox eine Nachricht sehen die ungefähr so aussieht:
49
50```
51*** Clueboard - Clueboard 66% HotSwap disconnected -- 0xC1ED:0x2390
52*** DFU device connected
53```
54
55### Tastatur flashen
56
57Klicke auf den `Flash`-Knopf in der QMK Toolbox. Die Ausgabe wird ungefähr so aussehen:
58
59```
60*** Clueboard - Clueboard 66% HotSwap disconnected -- 0xC1ED:0x2390
61*** DFU device connected
62*** Attempting to flash, please don't remove device
63>>> dfu-programmer atmega32u4 erase --force
64 Erasing flash... Success
65 Checking memory from 0x0 to 0x6FFF... Empty.
66>>> dfu-programmer atmega32u4 flash qmk_firmware/clueboard_66_hotswap_skully.hex
67 Checking memory from 0x0 to 0x55FF... Empty.
68 0% 100% Programming 0x5600 bytes...
69 [>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>] Success
70 0% 100% Reading 0x7000 bytes...
71 [>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>] Success
72 Validating... Success
73 0x5600 bytes written into 0x7000 bytes memory (76.79%).
74>>> dfu-programmer atmega32u4 reset
75
76*** DFU device disconnected
77*** Clueboard - Clueboard 66% HotSwap connected -- 0xC1ED:0x2390
78```
79
80## Tastatur mit der Befehlszeile flashen
81
82Zunächst solltest Du versuchen herauszufinden welchen Bootlader deine Tastatur benutzt. Diese vier Bootloader sind am Weitesten verbreitet:
83
84| MCU | Bootloader |
85| --- | --- |
86| Pro-Micro und Klone | CATERINA |
87| Teensy | Halfkay |
88| OLKB Boards | QMK-DFU |
89| sonstige atmega32u4 | DFU |
90
91Auf der Seite [Flash Anleitung und Bootloader Informationen](de/flashing.md) kannst Du mehr über das Thema erfahren.
92
93Wenn Du weißt welchen Bootloader deine Tastaur verwendet, kannst Du diese Information bei der Kompilation hinzufügen um den Flash-Vorgang mit dem `make`-Befehl zu automatisieren.
94```rules.mk
95...
96BOOTLOADER = caterina
97...
98```
99
100### DFU
101
102Wenn Du den DFU-Bootloader verwendest und Du bereit bist deine Firmware zu kompilieren und zu flashen, öffne ein Befehlszeile und führe folgenden Befehl aus:
103
104 make <meine_Tastatur>:<meine_Tastaturbelegung>:dfu
105
106Wenn deine Tastaturbelegung z.B den Namen "xzverz" trägt und Du ein rev5 planck flashen möchtest sähe der Befehl wie folgt aus:
107
108 make planck/rev5:xyverz:dfu
109
110
111Nachdem der Vorgang abgeschlossen ist sollte die Ausgabe ungefähr so aussehen:
112
113```
114Linking: .build/planck_rev5_xyverz.elf [OK]
115Creating load file for flashing: .build/planck_rev5_xyverz.hex [OK]
116Copying planck_rev5_xyverz.hex to qmk_firmware folder [OK]
117Checking file size of planck_rev5_xyverz.hex
118 * File size is fine - 18574/28672
119 ```
120
121Wenn dieser Punkt erreicht ist wird das Build-Skript alle 5 Sekunden nach einem DFU Bootloader suchen. Dieser Vorgang wird wiederholt bis er erfolgreich ist oder abgebrochen wird.
122
123 dfu-programmer: no device present.
124 Error: Bootloader not found. Trying again in 5s.
125
126Wenn diese Nachricht erscheint konnte das Build-Skript den Controller nicht eigenständig in den DFU Modus versetzen (z.B. weil der Modus in rules.mk falsch gesetzt wurde oder ein Problem mit der Hardware besteht), wenn dies eintritt musst Du die oben beschrieben Schritte benutzen um den Controller in den DFU Modus zu versetzen. Danach sollte die Ausgabe ungefähr so aussehen:
127
128```
129*** Attempting to flash, please don't remove device
130>>> dfu-programmer atmega32u4 erase --force
131 Erasing flash... Success
132 Checking memory from 0x0 to 0x6FFF... Empty.
133>>> dfu-programmer atmega32u4 flash qmk_firmware/clueboard_66_hotswap_skully.hex
134 Checking memory from 0x0 to 0x55FF... Empty.
135 0% 100% Programming 0x5600 bytes...
136 [>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>] Success
137 0% 100% Reading 0x7000 bytes...
138 [>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>] Success
139 Validating... Success
140 0x5600 bytes written into 0x7000 bytes memory (76.79%).
141>>> dfu-programmer atmega32u4 reset
142```
143
144?> Wenn Du mit diesem Schritt Probleme hast (z.B. `dfu-programmer: no device present`) hilft dir hoffentlich der Abschnitt [Häufig gestellte Fragen (Build/Kompilieren)](de/faq_build.md).
145
146#### DFU Befehle
147
148Es gibt verschiedene DFU Befehle um die Firmware auf ein DFU Gerät zu flashen:
149
150* `:dfu` - Dies ist die default Option. Es wird gecheckt ob ein DFU Gerät verfügbar ist, ist dies der Fall wird die Firmware geflasht. Dieser Check wird alle 5 Sekunden ausgeführt bis ein DFU Gerät erkannt wird.
151* `:dfu-ee` - Der Flash-Vorgang benutzt eine `.eep` Datei anstatt einer `.hex` Datei. Dies ist eher unüblich.
152* `:dfu-split-left` - Dies flasht die Firmware wie gewohnt (`:dfu`). Allerdings nur die "linke Seite" der EEPROM für geteilte Tastaturen. _Dies ist ideal für auf Elite C basierenden geteilten Tastaturen._
153* `:dfu-split-right` - Dies flasht die Firmware wie gewohnt (`:dfu`). Allerdings nur die "rechte Seite" der EEPROM für geteilte Tastaturen. _Dies ist ideal für auf Elite C basierenden geteilten Tastaturen._
154
155
156### Caterina
157Für Arduinos und andere ProMicro Klone (z.B. SparkFun ProMicro), wenn Du bereit bist zu kompilieren und die Tastatur zu flashen, öffne ein Befehlszeilen-Fenster und führe den Build-Befehl aus:
158
159 make <meine_Tastatur>:<meine_Tastaturbelegung>:avrdude
160
161Wenn deine Tastaturbelegung zum Beispiel den Namen "xyverz" hat und Du eine Tastaturbelegung für ein "rev2 Lets Split" erzeugen möchtest, lautet der Befehl dafür:
162
163 make lets_split/rev2:xyverz:avrdude
164
165Nachdem die Kompilation abgeschlossen ist sollte die Ausgabe ungefähr so aussehen:
166
167```
168Linking: .build/lets_split_rev2_xyverz.elf [OK]
169Creating load file for flashing: .build/lets_split_rev2_xyverz.hex [OK]
170Checking file size of lets_split_rev2_xyverz.hex [OK]
171 * File size is fine - 27938/28672
172Detecting USB port, reset your controller now..............
173```
174
175Nun wird die Tastatur automatisch zurückgesetzt und das Skript wird die Firmware flashen sobald es den Bootloader erkennt. Die Ausgabe sollte ungefähr so aussehen:
176
177```
178Detected controller on USB port at /dev/ttyS15
179
180Connecting to programmer: .
181Found programmer: Id = "CATERIN"; type = S
182 Software Version = 1.0; No Hardware Version given.
183Programmer supports auto addr increment.
184Programmer supports buffered memory access with buffersize=128 bytes.
185
186Programmer supports the following devices:
187 Device code: 0x44
188
189avrdude.exe: AVR device initialized and ready to accept instructions
190
191Reading | ################################################## | 100% 0.00s
192
193avrdude.exe: Device signature = 0x1e9587 (probably m32u4)
194avrdude.exe: NOTE: "flash" memory has been specified, an erase cycle will be performed
195 To disable this feature, specify the -D option.
196avrdude.exe: erasing chip
197avrdude.exe: reading input file "./.build/lets_split_rev2_xyverz.hex"
198avrdude.exe: input file ./.build/lets_split_rev2_xyverz.hex auto detected as Intel Hex
199avrdude.exe: writing flash (27938 bytes):
200
201Writing | ################################################## | 100% 2.40s
202
203avrdude.exe: 27938 bytes of flash written
204avrdude.exe: verifying flash memory against ./.build/lets_split_rev2_xyverz.hex:
205avrdude.exe: load data flash data from input file ./.build/lets_split_rev2_xyverz.hex:
206avrdude.exe: input file ./.build/lets_split_rev2_xyverz.hex auto detected as Intel Hex
207avrdude.exe: input file ./.build/lets_split_rev2_xyverz.hex contains 27938 bytes
208avrdude.exe: reading on-chip flash data:
209
210Reading | ################################################## | 100% 0.43s
211
212avrdude.exe: verifying ...
213avrdude.exe: 27938 bytes of flash verified
214
215avrdude.exe: safemode: Fuses OK (E:CB, H:D8, L:FF)
216
217avrdude.exe done. Thank you.
218```
219Sollten dabei Probleme auftreten (z.B. "Zugriff verweigert" / "Permission denied") muss der Make-Befehl mit privilegierten Berechtigungen ausgeführt werden:
220
221 sudo make <meine_Tastatur>:<meine_Tastaturbelegung>:avrdude
222
223Zusätzlich ist es möglich mehrere Tastaturen in einem Vorgang zu flashen:
224
225 make <keyboard>:<keymap>:avrdude-loop
226
227Du kannst den Loop mit STRG + C unterbrechen sobald der Vorgang abgeschlossen ist. Die korrekte Tastenkombination kann abweichen und hängt vom Betriebssystem ab.
228
229
230### HalfKay
231
232Für Tastaturen mit PJRC Controllern (Teensy's), wenn Du bereit bist zu kompilieren und die Tastatur zu flashen, öffne ein Befehlszeilen-Fenster und führe den Build-Befehl aus:
233
234 make <meine_Tastatur>:<meine_Tastaturbelegung>:teensy
235
236Wenn deine Tastaturbelegung zum Beispiel den Namen "xyverz" hat und Du eine Tastaturbelegung für ein Ergodox oder Ergodox EZ erzeugen möchtest, lautet der Befehl dafür:
237
238 make ergodox_ez:xyverz:teensy
239
240Nachdem die Kompilation abgeschlossen ist sollte die Ausgabe ungefähr so aussehen:
241
242```
243Linking: .build/ergodox_ez_xyverz.elf [OK]
244Creating load file for flashing: .build/ergodox_ez_xyverz.hex [OK]
245Checking file size of ergodox_ez_xyverz.hex [OK]
246 * File size is fine - 25584/32256
247 Teensy Loader, Command Line, Version 2.1
248Read "./.build/ergodox_ez_xyverz.hex": 25584 bytes, 79.3% usage
249Waiting for Teensy device...
250 (hint: press the reset button)
251 ```
252
253An diesem Punkt solltest Du die Tastatur zurücksetzen um den Flash-Vorgang auszulösen. Wenn dies abgeschlossen ist sollte die Ausgabe ungefähr so aussehen:
254
255 ```
256Found HalfKay Bootloader
257Read "./.build/ergodox_ez_xyverz.hex": 28532 bytes, 88.5% usage
258Programming.............................................................
259...................................................
260Booting
261```
262
263### BootloadHID
264
265Für auf Bootmapper Client(BMC)/bootloaderHID/ATmega32A basierende Tastaturen, wenn Du bereit bist zu kompilieren und die Tastatur zu flashen, öffne ein Befehlszeilen-Fenster und führe den Build-Befehl aus:
266
267 make <meine_Tastatur>:<meine_Tastaturbelegung>:bootloaderHID
268
269Wenn deine Tastaturbelegung zum Beispiel den Namen "xyverz" hat und Du eine Tastaturbelegung für ein jj40 erzeugen möchtest, lautet der Befehl dafür:
270
271 make jj40:xyverz:bootloaderHID
272
273Nachdem die Kompilation abgeschlossen ist sollte die Ausgabe ungefähr so aussehen:
274
275```
276Linking: .build/jj40_default.elf [OK]
277Creating load file for flashing: .build/jj40_default.hex [OK]
278Copying jj40_default.hex to qmk_firmware folder [OK]
279Checking file size of jj40_default.hex [OK]
280 * The firmware size is fine - 21920/28672 (6752 bytes free)
281```
282
283Wenn dieser Punkt erreicht ist wird das Build-Skript alle 5 Sekunden nach einem DFU Bootloader suchen. Dieser Vorgang wird wiederholt bis er erfolgreich ist oder abgebrochen wird.
284
285```
286Error opening HIDBoot device: The specified device was not found
287Trying again in 5s.
288```
289
290An diesem Punkt solltest Du die Tastatur zurücksetzen um den Flash-Vorgang auszulösen. Wenn dies abgeschlossen ist sollte die Ausgabe ungefähr so aussehen:
291
292```
293Page size = 128 (0x80)
294Device size = 32768 (0x8000); 30720 bytes remaining
295Uploading 22016 (0x5600) bytes starting at 0 (0x0)
2960x05580 ... 0x05600
297```
298
299### STM32 (ARM)
300
301Für die meisten ARM Tastaturen (inkl. Proton C, Planck Rev 6 und Preonic Rev 3), wenn Du bereit bist zu kompilieren und die Tastatur zu flashen, öffne ein Befehlszeilen-Fenster und führe den Build-Befehl aus:
302
303 make <meine_Tastatur>:<meine_Tastaturbelegung>:dfu-util
304
305Wenn deine Tastaturbelegung zum Beispiel den Namen "xyverz" hat und Du eine Tastaturbelegung für ein Planck Revision 6 erzeugen möchtest, benutze dafür den folgenden Befehl und reboote die Tastatur in den Bootloader (kurz bevor der Kompiliervorgang abgeschlossen ist):
306
307 make planck/rev6:xyverz:dfu-util
308
309Nachdem der Kompiliervorgang abgeschlossen ist sollte die Ausgabe ungefähr so aussehen:
310
311Für auf Bootmapper Client(BMC)/bootloaderHID/ATmega32A basierende Tastaturen, wenn Du bereit bist zu kompilieren und die Tastatur zu flashen, öffne ein Befehlszeilen-Fenster und führe den Build-Befehl aus:
312
313 make <meine_Tastatur>:<meine_Tastaturbelegung>:bootloaderHID
314
315Wenn deine Tastaturbelegung zum Beispiel den Namen "xyverz" hat und Du eine Tastaturbelegung für ein jj40 erzeugen möchtest, lautet der Befehl dafür:
316```
317Linking: .build/planck_rev6_xyverz.elf [OK]
318Creating binary load file for flashing: .build/planck_rev6_xyverz.bin [OK]
319Creating load file for flashing: .build/planck_rev6_xyverz.hex [OK]
320
321Size after:
322 text data bss dec hex filename
323 0 41820 0 41820 a35c .build/planck_rev6_xyverz.hex
324
325Copying planck_rev6_xyverz.bin to qmk_firmware folder [OK]
326dfu-util 0.9
327
328Copyright 2005-2009 Weston Schmidt, Harald Welte and OpenMoko Inc.
329Copyright 2010-2016 Tormod Volden and Stefan Schmidt
330This program is Free Software and has ABSOLUTELY NO WARRANTY
331Please report bugs to http://sourceforge.net/p/dfu-util/tickets/
332
333Invalid DFU suffix signature
334A valid DFU suffix will be required in a future dfu-util release!!!
335Opening DFU capable USB device...
336ID 0483:df11
337Run-time device DFU version 011a
338Claiming USB DFU Interface...
339Setting Alternate Setting #0 ...
340Determining device status: state = dfuERROR, status = 10
341dfuERROR, clearing status
342Determining device status: state = dfuIDLE, status = 0
343dfuIDLE, continuing
344DFU mode device DFU version 011a
345Device returned transfer size 2048
346DfuSe interface name: "Internal Flash "
347Downloading to address = 0x08000000, size = 41824
348Download [=========================] 100% 41824 bytes
349Download done.
350File downloaded successfully
351Transitioning to dfuMANIFEST state
352```
353
354#### STM32 Befehle
355
356Für Tastaturen mit STM32 Controller sind die DFU Befehle wie folgt:
357
358* `:dfu-util` - The default command for flashing to STM32 devices.
359* `:dfu-util` - Der Standard-Befehl für STM32 Geräte.
360* `:dfu-util-wait` - Funktioniert wie der Standard-Befehl, aber mit einem 10 Sekunden Timeout bevor erneut versucht wird die Firmware zu flashen. Mit dem Parameter `TIME_DELAY=20` auf der Befehlszeile kann der Timeout beeinflusst werden.
361 * z.B.: `make <meine_Tastatur>:<meine_Tastaturbelegung>:dfu-util TIME_DELAY=5`
362* `:dfu-util-split-left` - Gleiche Funktionsweise wie `dfu-util`, jedoch wird zusätzlich das EEPROM Setting "linke Seite" für geteilte Tastaturen gesetzt.
363* `:dfu-util-split-right` - Gleiche Funktionsweise wie `dfu-util`, jedoch wird zusätzlich das EEPROM Setting "rechte Seite" für geteilte Tastaturen gesetzt.
364
365## Probier's aus!
366
367Herzlichen Glückwunsch! Deine individuell angepasst Firmware wurde auf deine Tastatur übertragen!
368
369 Probiere deine neue Tastatur aus und gehe sicher dass alles wie gewünscht funktioniert. Wir haben einen weiteren Artikel zum Thema [Testen und Debuggen](de/newbs_testing_debugging.md) verfasst der sich mit Problembeseitigung beschäftigt um den Beginnger-Guide abzuschließen.
diff --git a/docs/de/newbs_getting_started.md b/docs/de/newbs_getting_started.md
deleted file mode 100644
index 188cf97e0..000000000
--- a/docs/de/newbs_getting_started.md
+++ /dev/null
@@ -1,101 +0,0 @@
1# Einleitung
2Genau wie in einem Computer befindet sich auch in einer Tastatur ein Prozessor.
3
4Dieser Prozessor führt Software aus, die registriert wenn Tasten gedrückt bzw. wieder losgelassen werden und leitet die entsprechenden Signale an den Computer weiter.
5
6QMK übernimmt die Rolle dieser Software und teilt dem Host-Computer den aktuellen Zustand der Tastatur mit. Wenn Du eine Tastaturbelegung definierst, ist dies äquivalent zu einem ausführbarem Programm, das auf deiner Tastatur läuft.
7
8QMK möchte seine BenutzerInnen in die Lage versetzen, simple Aufgaben möglichst einfach zu gestalten und gleichzeitig komplexe Dinge zu ermöglichen, die mit normalen Tastaturen ohne zusätzliche Software undenkbar wären. Du musst nicht programmieren können, um abgefahrene Tastaturbelegungen zu gestalten - es reicht wenn Du eine Idee hast und ein paar einfache syntaktische Regeln verstehen kannst.
9
10# Los geht's!
11Bevor Du damit loslegen kannst, deine Tastaturbelegung zu erstellen, musst Du ein wenig Software installieren und Dir eine Entwicklungsumgebung aufsetzen. Die gute Nachricht ist, dass das nur einmal erledigt werden muss, egal für wie viele verschiedene Tastaturen Du hinterher Firmware entwickeln willst.
12
13Wenn Du es vorziehst mit einer grafischen Oberfläche zu entwickeln kannst Du auch dazu gerne direkt mit dem online [QMK Konfigurator](https://config.qmk.fm) loslegen. Siehe auch: [Firmware mit der Online GUI erzeugen](de/newbs_building_firmware_configurator.md)
14
15## Software herunterladen
16
17### Text Editor
18
19Du wirst ein Programm benötigen, mit dem Du **plain text** (= reiner Text) Dateien bearbeiten und speichern kannst. Wenn Du Windows benutzt, reicht dafür schon das normale `Notepad` und für Linux z.B. `gedit` oder `leafpad`. Beide sind sehr rudimentäre Editoren deren Funktionsumfang aber vollkommen ausreicht. Für macOS' standard `TextEdit` muss man ein bisschen vorsichtig sein und darauf achten, beim Speichern explizit unter _Format_ die Option _Reiner Text_ auszuwählen.
20
21Ansonsten ist es empfehlenswert, einen Editor herunterzuladen der für die Programmierung und das Bearbeiten von Code ausgelegt ist wie z.b [Notepad++](https://notepad-plus-plus.org/), [Sublime Text](https://www.sublimetext.com/) oder [VS Code](https://code.visualstudio.com/).
22
23?> Immer noch unsicher, welcher Text Editor der Richtige für Dich ist? Laurence Bradford hat eine hervorragende [Einleitung](https://learntocodewith.me/programming/basics/text-editors/) zu dem Thema geschrieben (auf Englisch).
24
25### QMK Toolbox
26
27QMK Toolbox ist ein optionales grafisches Programm für Windows und macOS, das es erleichtern soll, deine Tastatur zu programmieren und zu debuggen. Du wirst es höchstwahrscheinlich früher oder später als unverzichtbar ansehen, wenn es darum geht eine Tastatur einfach zu flashen oder zu debuggen, da es ermöglicht, sich debug-Nachrichten direkt anzeigen zu lassen.
28
29[Hier kannst Du die aktuelle Version herunterladen.](https://github.com/qmk/qmk_toolbox/releases/latest)
30
31* Für Windows: `qmk_toolbox.exe` (portable) oder `qmk_toolbox_install.exe` (installer)
32* Für macOS: `QMK.Toolbox.app.zip` (portable) oder `QMK.Toolbox.pkg` (installer)
33
34## Die Entwicklungsumgebung aufsetzen
35
36
37Wir haben versucht, die Installation der Entwicklungsumgebung für QMK so einfach wie möglich zu gestalten. Alles, was Du tun musst, ist eine Linux oder Unix Umgebung aufzusetzen, danach macht QMK den Rest.
38
39?> Wenn Du das erste Mal mit der Linux/Unix Befehlszeile arbeitest, schadet es nicht, sich mit ein paar Grundlagen und Befehlen vertraut zu machen. Diese Ressourcen sollten ausreichen, um sich das Nötigste anzueignen um mit QMK arbeiten zu können:<br>
40[Erforderliche Linux Grundlagen](https://www.guru99.com/must-know-linux-commands.html)<br>
41[Noch ein paar Linux Befehle](https://www.tjhsst.edu/~dhyatt/superap/unixcmd.html)
42
43### Windows
44
45Du wirst MSYS2 (o.Ä.) und Git benötigen.
46
47* Befolge die Installationsanleitung auf der [MSYS2 Homepage](https://www.msys2.org)
48* Schließe alle offenen MSYS2 Fenster und öffne ein neues MSYS2 MinGW 64-bit Terminal
49* Installiere Git mit dem Kommando: `pacman -S git`
50
51### macOS
52
53Du wirst Homebrew benötigen. Folge dafür den Anweisungen auf der [Homebrew homepage](https://brew.sh).
54
55Nachdem Homebrew erfolgreich installiert ist, kannst Du mit _QMK aufsetzen_ fortfahren.
56
57### Linux
58
59Du benötigst Git, aber es ist ziemlich wahrscheinlich, dass es bereits installiert ist. Sollte dies nicht der Fall sein, kannst Du es mit dem folgenden Aufruf installieren:
60
61* Debian / Ubuntu / Devuan: `apt-get install git`
62* Fedora / Red Hat / CentOS: `yum install git`
63* Arch Linux: `pacman -S git`
64
65?> Docker ist ebenfalls eine Option für alle Plattformen. [Hier](de/getting_started_build_tools.md#docker) kannst Du dazu weitere Informationen finden.
66
67## QMK aufsetzen
68Wenn Du damit fertig bist, deine Linux/Unix Umgebung zu installieren, kannst Du damit fortfahren QMK herunterzuladen. Dafür werden wir mit Git das QMK Repository "klonen". Öffne ein Terminal oder ein MSYS2 MinGW Fenster, dies wirst Du für den Rest der Anleitung benötigen. In diesem Fenster rufst Du nun die beiden folgenden Kommandos auf:
69
70```shell
71git clone --recurse-submodules https://github.com/qmk/qmk_firmware.git
72cd qmk_firmware
73```
74?> Wenn Du bereits weißt, [wie man GitHub benutzt](de/getting_started_github.md), empfehlen wir, dass Du Dir ein eigenen Fork erstellst. Wenn Du nicht weißt, was das bedeuten soll, kannst Du diesen Ratschlag getrost ignorieren.
75
76QMK liefert ein Script mit, das helfen soll, Dir alles Weitere abzunehmen. Du kannst es mit dem folgenden Befehl aufrufen:
77
78 util/qmk_install.sh
79
80## Die Build-Umgebung testen
81
82Nun sollte hoffentlich alles Nötige für eine funktionierende QMK Build-Umgebung installiert sein und Du solltest in der Lage sein, die QMK-Firmware zu kompilieren. Um dies mit einer `default` Tastaturbelegung zu testen, kannst Du den folgenden Befehl ausprobieren:
83
84 make <keyboard>:default
85
86Der Befehl um z.B. die Firmware für ein _Clueboard 66%_ zu erzeugen lautet:
87
88 make clueboard/66/rev3:default
89
90Wenn es fertig ist, sollte der Output ungefähr so ähnlich wie das Folgende aussehen:
91
92```
93Linking: .build/clueboard_66_rev3_default.elf [OK]
94Creating load file for flashing: .build/clueboard_66_rev3_default.hex [OK]
95Copying clueboard_66_rev3_default.hex to qmk_firmware folder [OK]
96Checking file size of clueboard_66_rev3_default.hex [OK]
97 * The firmware size is fine - 26356/28672 (2316 bytes free)
98```
99
100# Eine eigene Tastaturbelegung erstellen
101Du bist nun fertig mit dem Setup der Entwicklungsumgebung und solltest somit in der Lage sein, deine eigenen Tastaturbelegungen zu erstellen. Um fortzufahren, folge bitte der nächsten Anleitung unter [Die erste Firmware](de/newbs_building_firmware.md).
diff --git a/docs/de/newbs_learn_more_resources.md b/docs/de/newbs_learn_more_resources.md
deleted file mode 100644
index ac5adb0c1..000000000
--- a/docs/de/newbs_learn_more_resources.md
+++ /dev/null
@@ -1,14 +0,0 @@
1# Lernmaterial
2
3Diese weiterführenden Ressourcen sind darauf ausgerichtet, Neulingen der QMK Commmunity mehr Informationen und ein besseres Verständnis zu einzelnen Themen zu bieten.
4
5Git Ressourcen:
6
7* [Gutes allgemeines Tutorial](https://www.codecademy.com/learn/learn-git) (auf Englisch)
8* [Git spielerisch anhand von Beispielen lernen](https://learngitbranching.js.org/) (auf Englisch)
9* [Mehr über den allgemeinen Umgang mit GitHub](getting_started_github.md)
10* [Mehr über Git im Bezug zu QMK](contributing.md)
11
12Mehr über die Arbeit mit der Befehlszeile:
13
14* [Gutes allgemeines Tutorial über die Arbeit mit der Befehlszeile](https://www.codecademy.com/learn/learn-the-command-line) (auf Englisch)
diff --git a/docs/de/newbs_testing_debugging.md b/docs/de/newbs_testing_debugging.md
deleted file mode 100644
index 4d4e7cfee..000000000
--- a/docs/de/newbs_testing_debugging.md
+++ /dev/null
@@ -1,102 +0,0 @@
1# Testen und Debuggen
2
3Nachdem Du deine Tastatur mit deiner angepassten Firmware geflasht hast, ist es nun an der Zeit sie auszuprobieren. Mit ein bisschen Glück sollte alles ohne Probleme funktionieren, wenn dies nicht der Fall ist, soll dieses Dokument dir dabei helfen, herauszufinden wo das Problem liegt.
4
5## Testen
6
7Die Tastatur zu testen ist relativ selbsterklärend. Drücke jede der Tasten um dich zu versichern, dass der gesendete Keyode der ist, den du erwarten würdest. Dafür gibt es sogar ein paar Programme die helfen sollen, dass keine Taste ausgelassen wurde.
8
9Anmerkung: Diese Programme werden weder von QMK bereitgestellt oder gutgeheißen.
10
11* [Switch Hitter](https://elitekeyboards.com/switchhitter.php) (Nur für Windows)
12* [Keyboard Viewer](https://www.imore.com/how-use-keyboard-viewer-your-mac) (Nur für Mac)
13* [Keyboard Tester](https://www.keyboardtester.com) (Web basiert)
14* [Keyboard Checker](https://keyboardchecker.com) (Web basiert)
15
16## Debuggen
17
18Deine Tastatur wird Debug Informationen liefern wenn Du `CONSOLE_ENABLE = yes` in deiner `rules.mk` gesetzt hast. Die default-Ausgabe ist sehr beschränkt und kann wenn nötig durch die Aktivierung des Debug-Modes erhöht werden. Benutze dafür entweder den `DEBUG` Keycode in deiner Tastaturbelegung, das [Command](de/feature_command.md)-Feature oder füge den folgenden Code zu deiner Tastaturbelegung hinzu.
19
20```c
21void keyboard_post_init_user(void) {
22 // Customise these values to desired behaviour
23 debug_enable=true;
24 debug_matrix=true;
25 //debug_keyboard=true;
26 //debug_mouse=true;
27}
28```
29
30### Debuggen mit der QMK Toolbox
31
32Für kompatible Plattformen kann die [QMK Toolbox](https://github.com/qmk/qmk_toolbox) benutzt werden um Debug-Nachrichten deiner Tastatur anzuzeigen.
33
34### Debuggen mit hid_listen
35
36Bevorzugst Du es lieber auf der Befehlszeile zu debuggen? Dafür eignet sich das Programm [hid_listen](https://www.pjrc.com/teensy/hid_listen.html) von PJRC. Binaries sind für Windows, Linux und MacOS verfügbar.
37
38<!-- FIXME: Describe the debugging messages here. -->
39
40## Eigene Debug-Nachrichten senden
41
42Manchmal ist es hilfreich Debug-Nachrichten innerhalb deines eigenen [Custom Codes](de/custom_quantum_functions.md) zu drucken. Das ist ziemlich einfach. Beginne damit `print.h` am Anfang deiner Datei zu inkludieren:
43
44```c
45#include "print.h"
46```
47
48Danach stehen dir verschiedene Druck-Funktionen zur Verfügung:
49
50* `print("string")`: Druckt einen simplen String
51* `uprintf("%s string", var)`: Druckt einen formatierten String
52* `dprint("string")` Druckt einen simplen String, aber nur wenn der Debug-Mode aktiviert ist
53* `dprintf("%s string", var)`: Druckt einen formatierten String, aber nur wenn der Debug-Mode aktiviert ist
54
55## Debug Beispiele
56
57Anbei findest Du eine Sammlung von hilfreichen Beispielen. Für weitere Informationen Informationen sei an dieser Stelle auf [Debugging/Troubleshooting QMK](de/faq_debug.md) verwiesen.
58
59### Which matrix position is this keypress?
60### Welche Matrix Position hat dieser Tastenanschlag
61
62Beim Portieren, oder bei der Fehlerdiagnose von PCB Problemen, ist es nützlich sich anzeigen zu lassen ob ein Tastenanschlag richtig erkannt wurde. Um die Protokollierung für diesen Fall zu aktivieren, füge bitte folgenden Code zu deiner Tastaturbelegung `keymap.c` hinzu.
63
64```c
65bool process_record_user(uint16_t keycode, keyrecord_t *record) {
66 // Wenn 'console' aktiviert ist wird die Matrix-Position und der Status jedes Tastenanschlags ausgegeben
67#ifdef CONSOLE_ENABLE
68 uprintf("KL: kc: %u, col: %u, row: %u, pressed: %u\n", keycode, record->event.key.col, record->event.key.row, record->event.pressed);
69#endif
70 return true;
71}
72```
73
74Beispiel Ausgabe:
75```text
76Waiting for device:.......
77Listening:
78KL: kc: 169, col: 0, row: 0, pressed: 1
79KL: kc: 169, col: 0, row: 0, pressed: 0
80KL: kc: 174, col: 1, row: 0, pressed: 1
81KL: kc: 174, col: 1, row: 0, pressed: 0
82KL: kc: 172, col: 2, row: 0, pressed: 1
83KL: kc: 172, col: 2, row: 0, pressed: 0
84```
85
86### Wieviel Zeit wurde benötigt um einen Tastenanschlag zu detektieren?
87
88Wenn Performance-Probleme auftreten ist es hilfreich die Frequenz, mit der die Matrix gescannt wird, zu wissen. Um dies in diesem Fall zu aktiveren füge, den folgenden Code zu deiner Tastaturbelegung in `config.h` hinzu.
89
90```c
91#define DEBUG_MATRIX_SCAN_RATE
92```
93
94Beispiel Ausgabe
95```text
96 > matrix scan frequency: 315
97 > matrix scan frequency: 313
98 > matrix scan frequency: 316
99 > matrix scan frequency: 316
100 > matrix scan frequency: 316
101 > matrix scan frequency: 316
102```
diff --git a/docs/es/README.md b/docs/es/README.md
deleted file mode 100644
index 0d504fad0..000000000
--- a/docs/es/README.md
+++ /dev/null
@@ -1,31 +0,0 @@
1# Firmware Quantum Mechanical Keyboard
2
3[![Versión actual](https://img.shields.io/github/tag/qmk/qmk_firmware.svg)](https://github.com/qmk/qmk_firmware/tags)
4[![Discord](https://img.shields.io/discord/440868230475677696.svg)](https://discord.gg/Uq7gcHh)
5[![Estado de la documentación](https://img.shields.io/badge/docs-ready-orange.svg)](https://docs.qmk.fm)
6[![Contribuyentes en GitHub](https://img.shields.io/github/contributors/qmk/qmk_firmware.svg)](https://github.com/qmk/qmk_firmware/pulse/monthly)
7[![Forks en GitHub](https://img.shields.io/github/forks/qmk/qmk_firmware.svg?style=social&label=Fork)](https://github.com/qmk/qmk_firmware/)
8
9## ¿Qué es el firmware QMK?
10
11QMK (*Quantum Mechanical Keyboard*) es una comunidad open source que mantiene el firmware QMK, QMK Toolbox, qmk.fm, y estos documentos. El firmware QMK es un firmware para teclados basado en [tmk\_keyboard](https://github.com/tmk/tmk_keyboard) con algunas características útiles para controladores Atmel AVR, y más específicamente, la [línea de productos OLKB](https://olkb.com), el teclado [ErgoDox EZ](https://www.ergodox-ez.com), y la [línea de productos Clueboard](https://clueboard.co/). También ha sido portado a chips ARM chips usando ChibiOS. Lo puedes utilizar para manejar tu propio teclado ya sea cableado a mano o basado en una PCB personalizada.
12
13## Cómo conseguirlo
14
15Si estás pensando en contribuir con un keymap, teclado, or característica a QMK, la manera más sencilla es hacer un [fork del repositorio en GitHub](https://github.com/qmk/qmk_firmware#fork-destination-box), y clonar tu repositorio localmente para hacer los cambios, subirlos, y abir un [Pull Request](https://github.com/qmk/qmk_firmware/pulls) desde tu fork.
16
17De cualquier manera, también puedes descargarlo directamente en formatos ([zip](https://github.com/qmk/qmk_firmware/zipball/master), [tar](https://github.com/qmk/qmk_firmware/tarball/master)), o clonarlo via git (`git@github.com:qmk/qmk_firmware.git`), o https (`https://github.com/qmk/qmk_firmware.git`).
18
19## Cómo compilar
20
21Antes de poder compilar, necesitarás [instalar un entorno](es/getting_started_build_tools.md) para el desarrollo de AVR y/o ARM. Una vez hayas completado este paso, usarás el comando `make` para compilar un teclado y keymap con la siguiente notación:
22
23 make planck/rev4:default
24
25Este ejemplo compilaría la revisión `rev4` del teclado `planck` con el keymap `default`. No todos los teclados tienen revisiones (también llamados subproyectos o carpetas), en ese caso, se puede omitir:
26
27 make preonic:default
28
29## Cómo personalizar
30
31QMK tiene montones de [características](es/features.md) para explorar, y una buena cantidad de [documentación de referencia](https://docs.qmk.fm) en la que sumergirse. Se pueden sacar provecho de la mayoría de las características modificando tu [keymap](es/keymap.md), y cambiando los [keycodes](es/keycodes.md).
diff --git a/docs/es/_summary.md b/docs/es/_summary.md
deleted file mode 100644
index aa2a0ca5d..000000000
--- a/docs/es/_summary.md
+++ /dev/null
@@ -1,122 +0,0 @@
1* [Guía completa para novatos](es/newbs.md)
2 * [Empezando](es/newbs_getting_started.md)
3 * [Construyendo tu primer firmare](es/newbs_building_firmware.md)
4 * [Flasheando el firmware](es/newbs_flashing.md)
5 * [Testeando y depurando ](es/newbs_testing_debugging.md)
6 * [Mejores práticas](es/newbs_best_practices.md)
7 * [Recursos de aprendizaje](es/newbs_learn_more_resources.md)
8
9* [QMK Basics](es/README.md)
10 * [Introducción a QMK](es/getting_started_introduction.md)
11 * [QMK CLI](es/cli.md)
12 * [Configuración de QMK CLI](es/cli_configuration.md)
13 * [Contribuyendo a QMK](es/contributing.md)
14 * [Cómo usar GitHub](es/getting_started_github.md)
15 * [Obtener ayuda](es/getting_started_getting_help.md)
16
17* [Cambios incompatibles](es/breaking_changes.md)
18 * [30 Ago 2019](es/ChangeLog/20190830.md)
19
20* [Preguntas frecuentes](es/faq.md)
21 * [General](es/faq_general.md)
22 * [Construir/Compilar QMK](es/faq_build.md)
23 * [Depurando/Encontrando problemas en QMK](es/faq_debug.md)
24 * [Keymap](es/faq_keymap.md)
25 * [Instalación de drivers con Zadig](es/driver_installation_zadig.md)
26
27* Guías detalladas
28 * [Instalar herramientas construcción](es/getting_started_build_tools.md)
29 * [Guía Vagrant](es/getting_started_vagrant.md)
30 * [Instrucciones de Construcción/Compilado](es/getting_started_make_guide.md)
31 * [Flasheando Firmware](es/flashing.md)
32 * [Personalizando funcionalidad](es/custom_quantum_functions.md)
33 * [Visión general del Keymap](es/keymap.md)
34
35* [Hardware](es/hardware.md)
36 * [Procesadores AVR](es/hardware_avr.md)
37 * [Drivers](es/hardware_drivers.md)
38
39* Referencia
40 * [Pautas de teclados](es/hardware_keyboard_guidelines.md)
41 * [Opciones de configuración](es/config_options.md)
42 * [Keycodes](es/keycodes.md)
43 * [Convenciones de código - C](es/coding_conventions_c.md)
44 * [Convenciones de código - Python](es/coding_conventions_python.md)
45 * [Mejores prácticas de documentación](es/documentation_best_practices.md)
46 * [Plantillas de documentación](es/documentation_templates.md)
47 * [Glosario](es/reference_glossary.md)
48 * [Tests unitarios](es/unit_testing.md)
49 * [Funciones útiles](es/ref_functions.md)
50 * [Sporte configurador](es/reference_configurator_support.md)
51 * [Formato info.json](es/reference_info_json.md)
52 * [Desarrollo Python CLI](es/cli_development.md)
53
54* [Características](es/features.md)
55 * [Keycodes Básicos](es/keycodes_basic.md)
56 * [Teclas US ANSI Shifted](es/keycodes_us_ansi_shifted.md)
57 * [Keycodes Quantum](es/quantum_keycodes.md)
58 * [Keycodes Avanzados](es/feature_advanced_keycodes.md)
59 * [Audio](es/feature_audio.md)
60 * [Auto Shift](es/feature_auto_shift.md)
61 * [Retroiluminación](es/feature_backlight.md)
62 * [Bluetooth](es/feature_bluetooth.md)
63 * [Bootmagic](es/feature_bootmagic.md)
64 * [Combos](es/feature_combo.md)
65 * [Comando](es/feature_command.md)
66 * [API Debounce](es/feature_debounce_type.md)
67 * [Switch DIP](es/feature_dip_switch.md)
68 * [Macros Dinámicas](es/feature_dynamic_macros.md)
69 * [Encoders](es/feature_encoders.md)
70 * [Grave Escape](es/feature_grave_esc.md)
71 * [Feedback Háptico](es/feature_haptic_feedback.md)
72 * [Controlador LCD HD44780](es/feature_hd44780.md)
73 * [Key Lock](es/feature_key_lock.md)
74 * [Layouts](es/feature_layouts.md)
75 * [Tecla Leader](es/feature_leader_key.md)
76 * [Matriz LED](es/feature_led_matrix.md)
77 * [Macros](es/feature_macros.md)
78 * [Teclas del ratón](es/feature_mouse_keys.md)
79 * [Driver OLED](es/feature_oled_driver.md)
80 * [Teclas One Shot](es/one_shot_keys.md)
81 * [Dispositivo de apuntado](es/feature_pointing_device.md)
82 * [Ratón PS/2](es/feature_ps2_mouse.md)
83 * [Iluminación RGB](es/feature_rgblight.md)
84 * [Matriz RGB](es/feature_rgb_matrix.md)
85 * [Cadete espacial](es/feature_space_cadet.md)
86 * [Teclado dividido](es/feature_split_keyboard.md)
87 * [Stenografía](es/feature_stenography.md)
88 * [Swap Hands](es/feature_swap_hands.md)
89 * [Tap Dance](es/feature_tap_dance.md)
90 * [Terminal](es/feature_terminal.md)
91 * [Impresora Térmica](es/feature_thermal_printer.md)
92 * [Unicode](es/feature_unicode.md)
93 * [Userspace](es/feature_userspace.md)
94 * [Velocikey](es/feature_velocikey.md)
95
96* Para Makers y Modders
97 * [Guía de cableado a mano](es/hand_wire.md)
98 * [Guía de flasheado de ISP](es/isp_flashing_guide.md)
99 * [Guía de depuración de ARM](es/arm_debugging.md)
100 * [Driver I2C](es/i2c_driver.md)
101 * [Driver SPI](es/spi_driver.md)
102 * [Controles GPIO](es/internals_gpio_control.md)
103 * [Conversión Proton C](es/proton_c_conversion.md)
104
105* Para entender en profundidad
106 * [Cómo funcionan los teclados](es/how_keyboards_work.md)
107 * [Entendiendo QMK](es/understanding_qmk.md)
108
109* Otros temas
110 * [Usando Eclipse con QMK](es/other_eclipse.md)
111 * [Usando VSCode con QMK](es/other_vscode.md)
112 * [Soporte](es/getting_started_getting_help.md)
113 * [Cómo añadir traducciones](es/translating.md)
114
115* QMK Internals (En progreso)
116 * [Defines](es/internals_defines.md)
117 * [Input Callback Reg](es/internals_input_callback_reg.md)
118 * [Dispositivo Midi](es/internals_midi_device.md)
119 * [Proceso de configuración de un dispositivo Midi](es/internals_midi_device_setup_process.md)
120 * [Utilidad Midi](es/internals_midi_util.md)
121 * [Funciones Send](es/internals_send_functions.md)
122 * [Herramientas Sysex](es/internals_sysex_tools.md)
diff --git a/docs/es/hardware.md b/docs/es/hardware.md
deleted file mode 100644
index 085c7e674..000000000
--- a/docs/es/hardware.md
+++ /dev/null
@@ -1,8 +0,0 @@
1# Hardware
2
3QMK es compatible con una variedad de hardware. Si tu procesador puede ser dirigido por [LUFA](https://www.fourwalledcubicle.com/LUFA.php) o [ChibiOS](https://www.chibios.org), probablemente puedes hacer que QMK se ejecute en él. Esta sección explora cómo hacer que QMK se ejecute y se comunique con hardware de todo tipo.
4
5* [Pautas de teclados](hardware_keyboard_guidelines.md)
6* [Procesadores AVR](hardware_avr.md)
7* Procesadores ARM (TBD)
8* [Drivers](hardware_drivers.md)
diff --git a/docs/es/hardware_avr.md b/docs/es/hardware_avr.md
deleted file mode 100644
index ac6a71565..000000000
--- a/docs/es/hardware_avr.md
+++ /dev/null
@@ -1,182 +0,0 @@
1# Teclados con Procesadores AVR
2
3Esta página describe el soporte para procesadores AVR en QMK. Los procesadores AVR incluyen el atmega32u4, atmega32u2, at90usb1286, y otros procesadores de la Corporación Atmel. Los procesadores AVR son MCUs de 8-bit que son diseñados para ser fáciles de trabajar. Los procesadores AVR más comunes en los teclados tienen USB y un montón de GPIO para permitir grandes matrices de teclado. Son los MCUs más populares para el uso en los teclados hoy en día.
4
5Si aún no lo has hecho, debes leer las [Pautas de teclados](hardware_keyboard_guidelines.md) para tener una idea de cómo los teclados encajan en QMK.
6
7## Añadir tu Teclado AVR a QMK
8
9QMK tiene varias características para simplificar el trabajo con teclados AVR. Para la mayoría de los teclados no tienes que escribir ni una sola línea de código. Para empezar, ejecuta `qmk new-keyboard`:
10
11```
12$ qmk new-keyboard
13Ψ Generating a new QMK keyboard directory
14
15Keyboard Name: mycoolkeeb
16Keyboard Type:
17 1. avr
18 2. ps2avrgb
19Please enter your choice: [1]
20Your Name: [John Smith]
21Ψ Copying base template files...
22Ψ Copying avr template files...
23Ψ Renaming keyboard.[ch] to mycoolkeeb.[ch]...
24Ψ Replacing %YEAR% with 2021...
25Ψ Replacing %KEYBOARD% with mycoolkeeb...
26Ψ Replacing %YOUR_NAME% with John Smith...
27
28Ψ Created a new keyboard called mycoolkeeb.
29Ψ To start working on things, `cd` into keyboards/mycoolkeeb,
30Ψ or open the directory in your preferred text editor.
31```
32
33Esto creará todos los archivos necesarios para tu nuevo teclado, y rellenará la configuración con valores predeterminados. Ahora sólo tienes que personalizarlo para tu teclado.
34
35## `readme.md`
36
37Aquí es donde describirás tu teclado. Por favor sigue la [Plantilla del readme de teclados](documentation_templates.md#keyboard-readmemd-template) al escribir tu `readme.md`. Te animamos a colocar una imagen en la parte superior de tu `readme.md`. Por favor, utiliza un servicio externo como [Imgur](https://imgur.com) para alojar las imágenes.
38
39## `<keyboard>.c`
40
41Aquí es donde pondrás toda la lógica personalizada para tu teclado. Muchos teclados no necesitan nada aquí. Puedes aprender más sobre cómo escribir lógica personalizada en [Funciones Quantum Personalizadas](custom_quantum_functions.md).
42
43## `<keyboard>.h`
44
45Este es el archivo en el que defines tu(s) [Macro(s) de Layout](feature_layouts.md). Por lo menos deberías tener un `#define LAYOUT` para tu teclado que se ve algo así:
46
47```c
48#define LAYOUT( \
49 k00, k01, k02, \
50 k10, k11 \
51) { \
52 { k00, k01, k02 }, \
53 { k10, KC_NO, k11 }, \
54}
55```
56
57La primera mitad de la macro pre-procesador `LAYOUT` define la disposición física de las llaves. La segunda mitad de la macro define la matriz a la que están conectados los interruptores. Esto te permite tener una disposición física de las llaves que difiere de la matriz de cableado.
58
59Cada una de las variables `k__` tiene que ser única, y normalmente sigue el formato `k<row><col>`.
60
61La matriz física (la segunda mitad) debe tener un número de filas igualando `MATRIX_ROWS`, y cada fila debe tener exactamente `MATRIX_COLS` elementos. Si no tienes tantas teclas físicas puedes usar `KC_NO` para rellenar los espacios en blanco.
62
63## `config.h`
64
65El archivo `config.h` es donde configuras el hardware y el conjunto de características para tu teclado. Hay un montón de opciones que se pueden colocar en ese archivo, demasiadas para listar allí. Para obtener una visión de conjunto completa de las opciones disponibles consulta la página de [Opciones de Configuración](config_options.md).
66
67### Configuración de hardware
68
69
70En la parte superior de `config.h` encontrarás ajustes relacionados con USB. Estos controlan la apariencia de tu teclado en el Sistema Operativo. Si no tienes una buena razón para cambiar debes dejar el `VENDOR_ID` como `0xFEED`. Para el `PRODUCT_ID` debes seleccionar un número que todavía no esté en uso.
71
72Cambia las líneas de `MANUFACTURER` y `PRODUCT` para reflejar con precisión tu teclado.
73
74```c
75#define VENDOR_ID 0xFEED
76#define PRODUCT_ID 0x6060
77#define DEVICE_VER 0x0001
78#define MANUFACTURER Tú
79#define PRODUCT mi_teclado_fantastico
80```
81
82?> Windows y macOS mostrarán el `MANUFACTURER` y `PRODUCT` en la lista de dispositivos USB. `lsusb` en Linux toma estos de la lista mantenida por el [Repositorio de ID USB](http://www.linux-usb.org/usb-ids.html) por defecto. `lsusb -v` mostrará los valores reportados por el dispositivo, y también están presentes en los registros del núcleo después de conectarlo.
83
84### Configuración de la matriz del teclado
85
86La siguiente sección del archivo `config.h` trata de la matriz de tu teclado. Lo primero que debes establecer es el tamaño de la matriz. Esto es generalmente, pero no siempre, el mismo número de filas y columnas como la disposición física de las teclas.
87
88```c
89#define MATRIX_ROWS 2
90#define MATRIX_COLS 3
91```
92
93Una vez que hayas definido el tamaño de tu matriz, necesitas definir qué pines en tu MCU están conectados a filas y columnas. Para hacerlo simplemente especifica los nombres de esos pines:
94
95```c
96#define MATRIX_ROW_PINS { D0, D5 }
97#define MATRIX_COL_PINS { F1, F0, B0 }
98#define UNUSED_PINS
99```
100
101El número de entradas debe ser el mismo que el número que asignaste a `MATRIX_ROWS`, y del mismo modo para `MATRIX_COL_PINS` y `MATRIX_COLS`. No tienes que especificar `UNUSED_PINS`, pero puedes si deseas documentar qué pines están abiertos.
102
103Finalmente, puedes especificar la dirección en la que apuntan tus diodos. Esto puede ser `COL2ROW` o `ROW2COL`.
104
105```c
106#define DIODE_DIRECTION COL2ROW
107```
108
109#### Matriz de patas directas
110Para configurar un teclado en el que cada interruptor está conectado a un pin y tierra separados en lugar de compartir los pines de fila y columna, usa `DIRECT_PINS`. La asignación define los pines de cada interruptor en filas y columnas, de izquierda a derecha. Debe ajustarse a los tamaños dentro de `MATRIX_ROWS` y `MATRIX_COLS`. Usa `NO_PIN` para rellenar espacios en blanco. Sobreescribe el comportamiento de `DIODE_DIRECTION`, `MATRIX_ROW_PINS` y `MATRIX_COL_PINS`.
111
112```c
113// #define MATRIX_ROW_PINS { D0, D5 }
114// #define MATRIX_COL_PINS { F1, F0, B0 }
115#define DIRECT_PINS { \
116 { F1, E6, B0, B2, B3 }, \
117 { F5, F0, B1, B7, D2 }, \
118 { F6, F7, C7, D5, D3 }, \
119 { B5, C6, B6, NO_PIN, NO_PIN } \
120}
121#define UNUSED_PINS
122
123/* COL2ROW, ROW2COL */
124//#define DIODE_DIRECTION
125```
126
127### Configuración de retroiluminación
128
129QMK soporta retroiluminación en la mayoría de los pines GPIO. Algunos de ellos pueden ser manejados por el MCU en hardware. Para más detalles, consulta la [Documentación de Retroiluminación](feature_backlight.md).
130
131```c
132#define BACKLIGHT_PIN B7
133#define BACKLIGHT_LEVELS 3
134#define BACKLIGHT_BREATHING
135#define BREATHING_PERIOD 6
136```
137
138### Otras opciones de configuración
139
140Hay un montón de características que se pueden configurar o ajustar en `config.h`. Debes consultar la página de [Opciones de Configuración](config_options.md) para más detalles.
141
142## `rules.mk`
143
144Usa el archivo `rules.mk` para decirle a QMK qué archivos construir y qué características habilitar. Si estás construyendo sobre un atmega32u4 deberías poder dejar mayormente los valores predeterminados. Si estás usando otro MCU es posible que tengas que ajustar algunos parámetros.
145
146### Opciones MCU
147
148Estas opciones le indican al sistema de compilación para qué CPU construir. Ten mucho cuidado si cambias cualquiera de estos ajustes. Puedes inutilizar tu teclado.
149
150```make
151MCU = atmega32u4
152F_CPU = 16000000
153ARCH = AVR8
154F_USB = $(F_CPU)
155OPT_DEFS += -DINTERRUPT_CONTROL_ENDPOINT
156```
157
158### Gestores de arranque
159
160El gestor de arranque es una sección especial de tu MCU que te permite actualizar el código almacenado en el MCU. Piensa en ello como una partición de rescate para tu teclado.
161
162#### Ejemplo de gestor de arranque
163
164```make
165BOOTLOADER = halfkay
166```
167
168#### Ejemplo de cargador DFU Atmel
169
170```make
171BOOTLOADER = atmel-dfu
172```
173
174#### Ejemplo de gestor de arranque Pro Micro
175
176```make
177BOOTLOADER = caterina
178```
179
180### Opciones de construcción
181
182Hay un serie de características que se pueden activar o desactivar en `rules.mk`. Consulta la página de [Opciones de Configuración](config_options.md#feature-options) para obtener una lista detallada y una descripción.
diff --git a/docs/es/hardware_drivers.md b/docs/es/hardware_drivers.md
deleted file mode 100644
index 788de2c5e..000000000
--- a/docs/es/hardware_drivers.md
+++ /dev/null
@@ -1,31 +0,0 @@
1# Controladores de hardware QMK
2
3QMK se utiliza en un montón de hardware diferente. Mientras que el soporte para los MCUs y las configuraciones de matriz más comunes está integrado, hay una serie de controladores que se pueden añadir para soportar hardware adicional al teclado. Los ejemplos incluyen ratones y otros dispositivos de apuntamiento, extensores de i/o para teclados divididos, modúlos Bluetooth, y pantallas LCD, OLED y TFT.
4
5<!-- FIXME: Esto debe hablar de cómo se integran los controladores en QMK y cómo puedes añadir su propio controlador.
6
7# Descripción del sistema de controladores
8
9-->
10
11# Controladores disponibles
12
13## ProMicro (Solo AVR)
14
15Soporte para direccionar pines en el ProMicro por su nombre Arduino en lugar de su nombre AVR. Esto necesita ser mejor documentado. Si estás tratando de hacer esto y leer el código no ayuda por favor [abre una issue](https://github.com/qmk/qmk_firmware/issues/new) y podemos ayudarte por el proceso.
16
17## Controlador OLED SSD1306
18
19Soporte para pantallas OLED basadas en SSD1306. Para obtener más información consulta la página de [Característica de Controlador OLED](feature_oled_driver.md).
20
21## WS2812 (Solo AVR)
22
23Soporte para LEDs WS2811/WS2812{a,b,c}. Para obtener más información consulta la página de [Luz RGB](feature_rgblight.md).
24
25## IS31FL3731
26
27Soporte para hasta 2 controladores. Cada controlador implementa 2 matrices charlieplex para direccionar LEDs individualmente usando I2C. Esto permite hasta 144 LEDs del mismo color o 32 LEDs RGB. Para obtener más información sobre cómo configurar el controlador, consulta la página de [Matriz RGB](feature_rgb_matrix.md).
28
29## IS31FL3733
30
31Soporte para hasta un solo controlador con espacio para expansión. Cada controlador puede controlar 192 LEDs individuales o 64 LEDs RGB. Para obtener más información sobre cómo configurar el controlador, consulta la página de [Matriz RGB](feature_rgb_matrix.md).
diff --git a/docs/es/hardware_keyboard_guidelines.md b/docs/es/hardware_keyboard_guidelines.md
deleted file mode 100644
index 298a3b7ce..000000000
--- a/docs/es/hardware_keyboard_guidelines.md
+++ /dev/null
@@ -1,147 +0,0 @@
1# Pautas del teclado QMK
2
3Desde sus inicios, QMK ha crecido a pasos agigantados gracias a personas como tú que contribuyes a la creación y mantenimiento de nuestros teclados comunitarios. A medida que hemos crecido hemos descubierto algunos patrones que funcionan bien, y pedimos que te ajustes a ellos para que sea más fácil para que otras personas se beneficien de tu duro trabajo.
4
5
6## Nombrar tu Teclado/Proyecto
7
8Todos los nombres de teclado están en minúsculas, consistiendo sólo de letras, números y guiones bajos (`_`). Los nombres no pueden comenzar con un guión bajo. La barra de desplazamiento (`/`) se utiliza como un carácter de separación de subcarpetas.
9
10Los nombres `test`, `keyboard`, y `all` están reservados para las órdenes de make y no pueden ser usados como un nombre de teclado o subcarpeta.
11
12Ejemplos Válidos:
13
14* `412_64`
15* `chimera_ortho`
16* `clueboard/66/rev3`
17* `planck`
18* `v60_type_r`
19
20## Subcarpetas
21
22QMK utiliza subcarpetas tanto para organización como para compartir código entre las revisiones del mismo teclado. Puedes anidar carpetas hasta 4 niveles de profundidad:
23
24 qmk_firmware/keyboards/top_folder/sub_1/sub_2/sub_3/sub_4
25
26Si una subcarpeta tiene un archivo `rules.mk` será considerado un teclado compilable. Estará disponible en el configurador de QMK y se probará con `make all`. Si estás utilizando una carpeta para organizar varios teclados del mismo fabricante no debes tener un archivo `rules.mk`.
27
28Ejemplo:
29
30Clueboard utiliza subcarpetas para ambos propósitos: organización y revisiones de teclado.
31
32* [`qmk_firmware`](https://github.com/qmk/qmk_firmware/tree/master)
33 * [`keyboards`](https://github.com/qmk/qmk_firmware/tree/master/keyboards)
34 * [`clueboard`](https://github.com/qmk/qmk_firmware/tree/master/keyboards/clueboard) &larr; This is the organization folder, there's no `rules.mk` file
35 * [`60`](https://github.com/qmk/qmk_firmware/tree/master/keyboards/clueboard/60) &larr; This is a compilable keyboard, it has a `rules.mk` file
36 * [`66`](https://github.com/qmk/qmk_firmware/tree/master/keyboards/clueboard/66) &larr; This is also compilable- it uses `DEFAULT_FOLDER` to specify `rev3` as the default revision
37 * [`rev1`](https://github.com/qmk/qmk_firmware/tree/master/keyboards/clueboard/66/rev1) &larr; compilable: `make clueboard/66/rev1`
38 * [`rev2`](https://github.com/qmk/qmk_firmware/tree/master/keyboards/clueboard/66/rev2) &larr; compilable: `make clueboard/66/rev2`
39 * [`rev3`](https://github.com/qmk/qmk_firmware/tree/master/keyboards/clueboard/66/rev3) &larr; compilable: `make clueboard/66/rev3` or `make clueboard/66`
40
41## Estructura de carpetas de teclado
42
43Su teclado debe estar ubicado en `qmk_firm cuidada/keyboards/` y el nombre de la carpeta debe ser el nombre de su teclado como se describe en la sección anterior. Dentro de esta carpeta debe haber varios archivos:
44
45* `readme.md`
46* `info.json`
47* `config.h`
48* `rules.mk`
49* `<keyboard_name>.c`
50* `<keyboard_name>.h`
51
52### `readme.md`
53
54Todos los proyectos necesitan tener un archivo `readme.md` que explica lo que es el teclado, quién lo hizo y dónde está disponible. Si es aplicable, también debe contener enlaces a más información, como el sitio web del fabricante. Por favor, sigue la [plantilla publicada](documentation_templates.md#keyboard-readmemd-template).
55
56### `info.json`
57
58Este archivo es utilizado por la [API de QMK](https://github.com/qmk/qmk_api). Contiene la información que [configurador de QMK](https://config.qmk.fm/) necesita mostrar en una representación de su teclado. También puede establecer metadatos aquí. Para más información, consulta la [página de referencia](reference_info_json.md).
59
60### `config.h`
61
62Todos los proyectos necesitan tener un archivo `config.h` que establece cosas como el tamaño de la matriz, nombre del producto, USB VID/PID, descripción y otros ajustes. En general, usa este archivo para establecer la información esencial y los valores predeterminados para tu teclado que siempre funcionarán.
63
64### `rules.mk`
65
66La presencia de este archivo indica que la carpeta es un destino de teclado y se puede utilizar en las órdenes `make`. Aquí es donde estableces el entorno de compilación para tu teclado y configuras el conjunto predeterminado de características.
67
68### `<keyboard_name.c>`
69
70Aquí es donde escribirás código personalizado para tu teclado. Típicamente escribirás código para inicializar e interactuar con el hardware de tu teclado. Si tu teclado se compone de sólo una matriz de teclas sin LEDs, altavoces u otro hardware auxiliar este archivo puede estar en blanco.
71
72Las funciones siguientes se definen típicamente en este archivo:
73
74* `void matrix_init_kb(void)`
75* `void matrix_scan_kb(void)`
76* `bool process_record_kb(uint16_t keycode, keyrecord_t *record)`
77* `void led_set_kb(uint8_t usb_led)`
78
79### `<keyboard_name.h>`
80
81Este archivo se utiliza para definir la matriz para tu teclado. Debes definir al menos un macro de C que traduce una serie en una matriz que representa la matriz de interruptor físico para tu teclado. Si es posible construir tu teclado con múltiples diseños debes definir macros adicionales.
82
83Si solo tienes un diseño debes llamar a esta macro `LAYOUT`.
84
85Al definir diseños múltiples debes tener un diseño base, llamado `LAYOUT_all`, que soporte todas las posibles posiciones de switch en tu matriz, incluso si ese diseño es imposible de construir físicamente. Esta es la macro que deberías usar en tu keymap `predeterminado`. Debes tener keymaps adicionales llamados `default_ término layout>` que usen tus otras macros de diseño. Esto hará que sea más fácil para las personas utilizar los diseños que defines.
86
87Los nombres de las macros de diseño son completamente minúsculas, excepto por la palabra `LAYOUT` en el frente.
88
89Por ejemplo, si tienes un PCB de 60% que soporta ANSI e ISO podría definir los siguientes diseños y keymaps:
90
91| Nombre de diseño | Nombre de keymap | Descripción |
92|-------------|-------------|-------------|
93| LAYOUT_all | default | Un diseño que soporta tanto ISO como ANSI |
94| LAYOUT_ansi | default_ansi | Un diseño ANSI |
95| LAYOUT_iso | default_iso | Un diseño ISO |
96
97## Archivos de Imagen/Hardware
98
99En un esfuerzo por mantener el tamaño de repo abajo ya no estamos aceptando archivos binarios de cualquier formato, con pocas excepciones. Alojarlos en otro lugar (por ejemplo <https://imgur.com>) y enlazarlos en el `readme.md` es preferible.
100
101Para archivos de hardware (tales como placas, casos, pcb) puedes contribuir a [qmk.fm repo](https://github.com/qmk/qmk.fm) y estarán disponibles en [qmk.fm](https://qmk.fm). Archivos descargables se almacenan en `/<teclado>/` (nombre sigue el mismo formato que el anterior), se sirven en `https://qmk.fm/<teclado>/`, y se generan páginas de `/_pages/<teclado>/` que se sirven en la misma ubicación (Los archivos .md se generan en archivos .html mediante Jekyll). Echa un vistazo a la carpeta `lets_split` para ver un ejemplo.
102
103## Predeterminados de teclado
104
105Dada la cantidad de funcionalidad que expone QMK, es muy fácil confundir a los nuevos usuarios. Al armar el firmware predeterminado para tu teclado, te recomendamos limitar tus funciones y opciones habilitadas al conjunto mínimo necesario para soportar tu hardware. A continuación se formulan recomendaciones sobre características específicas.
106
107### Bootmagic y Command
108
109[Bootmagic](feature_bootmagic.md) and [Command](feature_command.md) son dos características relacionadas que permiten a un usuario controlar su teclado de manera no obvia. Te recomendamos que piense largo y tendido acerca de si vas a habilitar cualquiera de las características, y cómo vas a exponer esta funcionalidad. Tengas en cuenta que los usuarios que quieren esta funcionalidad puede habilitarla en sus keymaps personales sin afectar a todos los usuarios novatos que pueden estar usando tu teclado como su primera tarjeta programable.
110
111De lejos el problema más común con el que se encuentran los nuevos usuarios es la activación accidental de Bootmagic mientras están conectando su teclado. Están sosteniendo el teclado por la parte inferior, presionando sin saberlo en alt y barra espaciadora, y luego se dan cuenta de que estas teclas han sido intercambiadas en ellos. Recomendamos dejar esta característica deshabilitada de forma predeterminada, pero si la activas consideres establecer la opción `BOOTMAGIC_KEY_SALT` a una tecla que es difícil de presionar al conectar el teclado.
112
113Si tu teclado no tiene 2 teclas de cambio debes proporcionar un predeterminado de trabajo para `IS_COMMAND`, incluso cuando haya definido `COMMAND_ENABLE = no`. Esto dará a sus usuarios un valor predeterminado para ajustarse a si lo hacen enable Command.
114
115## Programación de teclado personalizado
116
117Como se documenta en [Funcionalidad de Adaptación](custom_quantum_functions.md) puedes definir funciones personalizadas para tu teclado. Por favor, tengas en cuenta que sus usuarios pueden querer personalizar ese comportamiento así, y hacer que sea posible para que puedan hacer eso. Si está proporcionando una función personalizada, por ejemplo `process_record_kb()`, asegúrese de que su función también llame a la versión` `_user()` de la llamada. También debes tener en cuenta el valor de retorno de la versión `_user()`, y ejecutar sólo tu código personalizado si el usuario devuelve `true`.
118
119## Proyectos Sin Producción/Conectados A Mano
120
121Estamos encantados de aceptar cualquier proyecto que utilice QMK, incluidos los prototipos y los cableados de mano, pero tenemos una carpeta `/keyboards/handwired/` separada para ellos, por lo que la carpeta `/keyboards/` principal no se llena. Si un proyecto prototipo se convierte en un proyecto de producción en algún momento en el futuro, ¡estaremos encantados de moverlo a la carpeta `/keyboards/` principal!
122
123## Advertencias como errores
124
125Al desarrollar su teclado, tengas en cuenta que todas las advertencias serán tratadas como errores - estas pequeñas advertencias pueden acumularse y causar errores más grandes en el camino (y pierdan es generalmente una mala práctica).
126
127## Derechos de autor
128
129Si estás adaptando la configuración de tu teclado de otro proyecto, pero no utilizando el mismo código, asegúrese de actualizar la cabecera de derechos de autor en la parte superior de los archivos para mostrar tu nombre, en este formato:
130
131 Copyright 2017 Tu nombre <tu@email.com>
132
133Si estás modificando el código de otra persona y sólo ha hecho cambios triviales debes dejar su nombre en la declaración de derechos de autor. Si has hecho un trabajo significativo en el archivo debe agregar tu nombre a la de ellos, así:
134
135 Copyright 2017 Su nombre <original_author@ejemplo.com> Tu nombre <tu@ejemplo.com>
136
137El año debe ser el primer año en que se crea el archivo. Si el trabajo se hizo a ese archivo en años posteriores puedes reflejar que mediante la adición del segundo año a la primera, como así:
138
139 Copyright 2015-2017 Tu nombre <tu@ejemplo.com>
140
141## Licencia
142
143El núcleo de QMC está licenciado bajo la [GNU General Public License](https://www.gnu.org/licenses/licenses.en.html). Si estás enviando binarios para los procesadores AVR puedes elegir cualquiera [GPLv2](https://www.gnu.org/licenses/old-licenses/gpl-2.0.html) o [GPLv3](https://www.gnu.org/licenses/gpl.html). Si estás enviando binarios para ARM procesadores debes elegir [GPL Versión 3](https://www.gnu.org/licenses/gpl.html) para cumplir con los [ChibiOS](https://www.chibios.org) licencia GPLv3.
144
145## Detalles técnicos
146
147Si estás buscando más información sobre cómo hacer que su teclado funcione con QMK, [echa un vistazo a la sección hardware](hardware.md)!
diff --git a/docs/es/newbs.md b/docs/es/newbs.md
deleted file mode 100644
index 7e08b679c..000000000
--- a/docs/es/newbs.md
+++ /dev/null
@@ -1,23 +0,0 @@
1# La guía completa de QMK para novatos
2
3QMK es un poderoso firmware Open Source para tu teclado mecánico. Puedes utilizar QMK para personalizar tu teclado en maneras a la vez simples y potentes. Gente de todos los niveles de habilidad, desde completos novatos hasta expertos programadores, han utilizado con éxito QMK para personalizar sus teclados. Esta guía te ayudará a hacer lo mismo, sin importar tu nivel de habilidad.
4
5¿No estás seguro de si tu teclado puede ejecutar QMK? Si es un teclado mecánico construido por ti mismo probablemente puedas. Damos soporte a [gran número de placas de hobbistas](https://qmk.fm/keyboards/), e incluso si tu teclado actual no pudiera ejecutar QMK no deberías tener problemas encontrando uno que cumpliera tus necesidades.
6
7## Visión general
8
9Hay 7 secciones principales en esta guía:
10
11* [Empezando](newbs_getting_started.md)
12* [Construyendo tu primer firmware](newbs_building_firmware.md)
13* [Construyendo tu primer firmware usando la GUI](newbs_building_firmware_configurator.md)
14* [Flasheando el firmware](newbs_flashing.md)
15* [Testeando y depurando](newbs_testing_debugging.md)
16* [Mejores práticas](newbs_best_practices.md)
17* [Recursos de aprendizaje](newbs_learn_more_resources.md)
18
19Esta guía está enfocada en ayudar a alguien que nunca ha compilado software con anterioridad. Toma decisiones y hace recomendaciones teniendo en cuenta este punto de vista. Hay métodos alternativos para muchos de estos procedimientos, y soportamos la mayoría de esas alternativas. Si tienes alguna duda sobre cómo llevar a cabo una tarea nos puedes [preguntar para que te guiemos](getting_started_getting_help.md).
20
21## Recursos adicionales
22
23* [Blog de Básicos de Thomas Baart's QMK](https://thomasbaart.nl/category/mechanical-keyboards/firmware/qmk/qmk-basics/) – Un blog creado por un usuario que cubre lo básico sobre cómo usar el firmware QMK Firmware, visto desde la perspectiva de un usuario nuevo.
diff --git a/docs/es/newbs_best_practices.md b/docs/es/newbs_best_practices.md
deleted file mode 100644
index 2f72eff78..000000000
--- a/docs/es/newbs_best_practices.md
+++ /dev/null
@@ -1,159 +0,0 @@
1# Mejores prácticas
2
3## O, "Cómo aprendí a dejar de preocuparme y amarle a Git."
4
5Este documento procura instruir a los novatos en las mejores prácticas para tener una experiencia más fácil en contribuir a QMK. Te guiaremos por el proceso de contribuir a QMK, explicando algunas maneras de hacerlo más fácilmente, y luego romperemos algunas cosas para enseñarte cómo arreglarlas.
6
7En este documento suponemos un par de cosas:
8
91. Tienes una cuenta de GitHub, y has hecho un [fork del repo qmk_firmware](getting_started_github.md) en tu cuenta.
102. Has [configurado tu entorno de desarrollo](newbs_getting_started.md?id=environment-setup).
11
12
13## La rama master de tu fork: Actualizar a menudo, nunca commit
14
15Se recomienda que para desarrollo con QMK, lo que sea que estés haciendo, mantener tu rama `master` actualizada, pero **nunca** commit en ella. Mejor, haz todos tus cambios en una rama de desarrollo y manda pull requests de tus ramas mientras programas.
16
17Para evitar los conflictos de merge &mdash; cuando dos o más usuarios han editado la misma parte de un archivo al mismo tiempo &mdash; mantén tu rama `master` actualizada, y empieza desarrollo nuevo creando una nueva rama.
18
19### Actualizando tu rama master
20
21Para mantener tu rama `master` actualizada, se recomienda agregar el repository ("repo") de Firmware QMK como un repo remoto en git. Para hacer esto, abre tu interfaz de línea de mandatos y ingresa:
22```
23git remote add upstream https://github.com/qmk/qmk_firmware.git
24```
25
26Para verificar que el repo ha sido agregado, ejecuta `git remote -v`, y lo siguiente debe aparecer:
27
28```
29$ git remote -v
30origin https://github.com/<your_username>/qmk_firmware.git (fetch)
31origin https://github.com/<your_username>/qmk_firmware.git (push)
32upstream https://github.com/qmk/qmk_firmware.git (fetch)
33upstream https://github.com/qmk/qmk_firmware.git (push)
34```
35
36Ya que has hecho esto, puedes buscar actualizaciones del repo ejecutando `git fetch upstream`. Esto busca las ramas y etiquetas &mdash; juntos conocidos como "refs" &mdash; del repo QMK, que ahora tiene el apodo `upstream`. Ahora podemos comparar los archivos en nuestro fork `origin` con los de QMK.
37
38Para actualizar la rama master de tu fork, ejecuta lo siguiente, pulsando Intro después de cada línea:
39
40```
41git checkout master
42git fetch upstream
43git pull upstream master
44git push origin master
45```
46
47Esto te coloca en tu rama master, busca los refs del repo de QMK, descarga la rama `master` actual a tu computadora, y después lo sube a tu fork.
48
49### Hacer cambios
50
51Para hacer cambios, crea una nueva rama ejecutando:
52
53```
54git checkout -b dev_branch
55git push --set-upstream origin dev_branch
56```
57
58Esto crea una nueva rama llamada `dev_branch`, te coloca en ella, y después guarda la nueva rama a tu fork. El parámetro `--set-upstream` le dice a git que use tu fork y la rama `dev_branch` cada vez que uses `git push` o `git pull` en esta rama. Solo necesitas usarlo la primera que que subes cambios; ya después, puedes usar `git push` o `git pull`, sin usar los demás parámetros.
59
60!> Con `git push`, puedes usar `-u` en vez de `--set-upstream` &mdash; `-u` es un alias de `--set-upstream`.
61
62Puedes nombrar tu rama casi cualquier cosa, pero se recomienda ponerle algo con relación a los cambios que vas a hacer.
63
64Por defecto `git checkout -b` se basará tu nueva rama en la rama en la cual estás actualmente. Puedes basar tu rama en otra rama existente agregando el nombre de la rama al comando:
65
66```
67git checkout -b dev_branch master
68```
69
70Ahora que tienes una rama development, abre tu editor de texto y haz los cambios que quieres. Se recomienda hacer varios commits pequeños a tu rama; de este modo cualquier cambio que causa problemas puede ser rastreado y deshecho si fuera necesario. Para hacer tus cambios, edita y guarda los archivos que necesitas actualizar, agrégalos al *staging area* de Git, y luego haz un commit a tu rama:
71
72```
73git add path/to/updated_file
74git commit -m "My commit message."
75```
76`git add` agrega los archivos que han sido cambiados al *staging area* de Git, lo cual es la "zona de preparación"de Git. Este contiene los cambios que vas a *commit* usando `git commit`, que guarda los cambios en el repo. Usa un mensaje de commit descriptivo para que puedas saber que ha cambiado fácilmente.
77
78!> Si has cambiado muchos archivos, pero todos los archivos son parte del mismo cambio, puedes usar `git add .` para agregar todos los archivos cambiados que están en tu directiro actual, en vez de agregar cada archivo manualmente.
79
80### Publicar tus cambios
81
82El útimo paso es subir tus cambios a tu fork. Para hacerlo, ejecuta `git push`. Ahora Git publicará el estado actual de `dev_branch` a tu fork.
83
84
85## Resolver los conflictos del merge
86
87A veces cuando el trabajo en una rama tarda mucho tiempo en completarse, los cambios que han sido hechos por otros chocan con los cambios que has hecho en tu rama cuando abres un pull request. Esto se llama un *merge conflict*, y es algo que ocurre cuando varias personas editan las mismas partes de los mismos archivos.
88
89### Rebase tus cambios
90
91Un *rebase* es la manera de Git de tomar los cambios que se aplicaron en un punto, deshacerlos, y aplicar estos mismos cambios en otro punto. En el caso de un conflicto de merge, puedes hacer un rebase de tu rama para recoger los cambios que has hecho.
92
93Para empezar, ejecuta lo siguiente:
94
95```
96git fetch upstream
97git rev-list --left-right --count HEAD...upstream/master
98```
99
100El comando `git rev-list` ejecutado aquí muestra el número de commits que difieren entre la rama actual y la rama master de QMK. Ejecutamos `git fetch` primero para asegurarnos de que tenemos los refs que representan es estado actual del repo upstream. El output del comando `git rev-list` muestra dos números:
101
102```
103$ git rev-list --left-right --count HEAD...upstream/master
1047 35
105```
106
107El primer número representa el número de commits en la rama actual desde que fue creada, y el segundo número es el número de commits hecho a `upstream/master` desde que la rama actual fue creada, o sea los cambios que no están registrados en la rama actual.
108
109Ahora que sabemos el estado actual de la rama actual y el del repo upstream, podemos empezar una operación rebase:
110
111```
112git rebase upstream/master
113```
114Esto le dice a Git que deshaga los commits en la rama actual, y después los re-aplica en la rama master de QMK.
115
116```
117$ git rebase upstream/master
118First, rewinding head to replay your work on top of it...
119Applying: Commit #1
120Using index info to reconstruct a base tree...
121M conflicting_file_1.txt
122Falling back to patching base and 3-way merge...
123Auto-merging conflicting_file_1.txt
124CONFLICT (content): Merge conflict in conflicting_file_1.txt
125error: Failed to merge in the changes.
126hint: Use 'git am --show-current-patch' to see the failed patch
127Patch failed at 0001 Commit #1
128
129Resolve all conflicts manually, mark them as resolved with
130"git add/rm <conflicted_files>", then run "git rebase --continue".
131You can instead skip this commit: run "git rebase --skip".
132To abort and get back to the state before "git rebase", run "git rebase --abort".
133```
134
135Esto nos dice que tenemos un conflicto de merge, y nos dice el nombre del archivo con el conflict. Abre el archivo en tu editor de texto, y en alguna parte del archivo verás algo así:
136
137```
138<<<<<<< HEAD
139<p>For help with any issues, email us at support@webhost.us.</p>
140=======
141<p>Need help? Email support@webhost.us.</p>
142>>>>>>> Commit #1
143```
144La línea `<<<<<<< HEAD` marca el principio de un conflicto de merge, y la línea `>>>>>>> Commit #1` marca el final, con las secciones de conflicto separadas por `=======`. La parte del lado `HEAD` is de la versión de QMK master del archivo, y la parte marcada con el mensaje de commit es de la rama actual.
145
146Ya que Git rastrea *cambios de archivos* en vez del contenido de los archivos directamente, si Git no puede encontrar el texto que estaba en el archivo antes del último commit, no sabrá cómo editar el archivo. El editar el archivo de nuevo resolverá este conflicto. Haz tus cambios, y guarda el archivo.
147
148```
149<p>Need help? Email support@webhost.us.</p>
150```
151
152Ahora ejecuta:
153
154```
155git add conflicting_file_1.txt
156git rebase --continue
157```
158
159Git registra los cambios al archivo con conflictos, y sigue aplicando los commits de nuestra rama hasta llegar al final.
diff --git a/docs/es/newbs_building_firmware.md b/docs/es/newbs_building_firmware.md
deleted file mode 100644
index ff9873c78..000000000
--- a/docs/es/newbs_building_firmware.md
+++ /dev/null
@@ -1,81 +0,0 @@
1# Construyendo tu primer firmware
2
3Ahora que has configurado tu entorno de construcción estas listo para empezar a construir firmwares personalizados. Para esta sección de la guía alternaremos entre 3 programas - tu gestor de ficheros, tu editor de texto , y tu ventana de terminal. Manten los 3 abiertos hasta que hayas acabado y estés contento con el firmware de tu teclado.
4
5Si has cerrado y reabierto la ventana de tu terminal después de seguir el primero paso de esta guía, no olvides hacer `cd qmk_firmware` para que tu terminal esté en el directorio correcto.
6
7## Navega a tu carpeta de keymaps
8
9Comienza navegando a la carpeta `keymaps` correspondiente a tu teclado.
10
11?> Si estás en macOS o Windows hay comandos que puedes utilizar fácilmente para abrir la carpeta keymaps.
12
13?> macOS:
14
15 abre keyboards/<keyboard_folder>/keymaps
16
17?> Windows:
18
19 inicia .\\keyboards\\<keyboard_folder>\\keymaps
20
21## Crea una copia del keymap `default`
22
23Una vez que tengas la carpeta `keymaps` abierta querrás crear una copia de la carpeta `default`. Recomendamos encarecidamente que nombres la carpeta igual que tu nombre de usuario de GitHub, pero puedes utilizar el nombre que quieras siempre que contenga sólo letras en minúscula, números y el caracter de guión bajo.
24
25Para automatizar el proceso, también tienes la opción de ejecutar el script `new_keymap.sh`.
26
27Navega a la carpeta `qmk_firmware/util` e introduce lo siguiente:
28
29```
30./new_keymap.sh <keyboard path> <username>
31```
32
33Por ejemplo, para un usuario llamado John, intentando hacer un keymap nuevo para el 1up60hse, tendría que teclear
34
35```
36./new_keymap.sh 1upkeyboards/1up60hse john
37```
38
39## Abre `keymap.c` con tu editor de texto favorito
40
41Abre tu `keymap.c`. Dentro de este fichero encontrarás la estructura que controla cómo se comporta tu teclado. En lo alto de `keymap.c` puede haber distintos defines y enums que hacen el keymap más fácil de leer. Continuando por abajo encontrarás una línea con este aspecto:
42
43 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
44
45Esta línea indica el comienzo del listado de Capas. Debajo encontrarás líneas que contienen o bien `LAYOUT` o `KEYMAP`, y estas líneas indican el comienzo de una capa. Debajo de esa línea está la lista de teclas que pertenecen a esa capa concreta.
46
47!> Cuando estés editando tu fichero de keymap ten cuidado con no añadir ni eliminar ninguna coma. Si lo haces el firmware dejará de compilar y puede no ser fácil averiguar dónde está la coma faltante o sobrante.
48
49## Personaliza el Layout a tu gusto
50
51Cómo completar esta paso depende enteramente de ti. Haz ese pequeño cambio que querías o rehaz completamente todo. Puedes eliminar capas si no las necesitas todas, o añadir nuevas hasta un total de 32. Comprueba la siguiente documentación para descubrir qué es lo que puedes definir aquí:
52
53* [Keycodes](keycodes.md)
54* [Características](features.md)
55* [Preguntas frecuentes](faq.md)
56
57?> Mientras estás descubriendo cómo funcionan los keymaps, haz pequeños cambios. Cambios mayores pueden hacer difícil la depuración de problemas que puedan aparecer.
58
59## Construye tu firmware
60
61Cuando los cambios a tu keymap están completos necesitarás construir el firmware. Para hacerlo vuelve a la ventana de tu terminal y ejecuta el siguiente comando:
62
63 make <my_keyboard>:<my_keymap>
64
65Por ejemplo, si tu keymap se llama "xyverz" y estás construyendo un keymap para un planck rev5, utilizarás el siguiente comando:
66
67 make planck/rev5:xyverz
68
69Mientras compila, recibirás un montón de información de salida en la pantalla informándote de qué ficheros están siendo compilados. Debería acabar con una información similar a esta:
70
71```
72Linking: .build/planck_rev5_xyverz.elf [OK]
73Creating load file for flashing: .build/planck_rev5_xyverz.hex [OK]
74Copying planck_rev5_xyverz.hex to qmk_firmware folder [OK]
75Checking file size of planck_rev5_xyverz.hex [OK]
76 * File size is fine - 18392/28672
77```
78
79## Flashea tu firmware
80
81Continua con [Flasheando el firmware](newbs_flashing.md) para aprender cómo escribir tu firmware nuevo en tu teclado.
diff --git a/docs/es/newbs_building_firmware_configurator.md b/docs/es/newbs_building_firmware_configurator.md
deleted file mode 100644
index 60d67f5fa..000000000
--- a/docs/es/newbs_building_firmware_configurator.md
+++ /dev/null
@@ -1,105 +0,0 @@
1# Configurador QMK
2
3El [Configurador QMK](https://config.qmk.fm) es un entorno gráfico online que genera ficheros hexadecimales de Firmware QMK.
4
5?> **Por favor sigue estos pasos en orden.**
6
7Ve el [Video tutorial](https://www.youtube.com/watch?v=-imgglzDMdY)
8
9El Configurador QMK functiona mejor con Chrome/Firefox.
10
11
12!> **Ficheros de otras herramientas como KLE, o kbfirmware no serán compatibles con el Configurador QMK. No las cargues, no las importes. El configurador Configurador QMK es una herramienta DIFERENTE. **
13
14## Seleccionando tu teclado
15
16Haz click en el desplegable y selecciona el teclado para el que quieres crear el keymap.
17
18?> Si tu teclado tiene varias versiones, asegúrate de que seleccionas la correcta.**
19
20Lo diré otra vez porque es importante
21
22!> **ASEGÚRATE DE QUE SELECCIONAS LA VERSIÓN CORRECTA!**
23
24Si se ha anunciado que tu teclado funciona con QMK pero no está en la lista, es probable que un desarrollador no se haya encargado de él aún o que todavía no hemos tenido la oportunidad de incluirlo. Abre un issue en [qmk_firmware](https://github.com/qmk/qmk_firmware/issues) solicitando soportar ese teclado un particular, si no hay un [Pull Request](https://github.com/qmk/qmk_firmware/pulls?q=is%3Aopen+is%3Apr+label%3Akeyboard) activo para ello. Hay también teclados que funcionan con QMK que están en las cuentas de GitHub de sus manufacturantes. Acuérdate de comprobar esto también.
25
26## Eligiendo el layout de tu teclado
27
28Elige el layout que mejor represente el keymap que quieres crear. Algunos teclados no tienen suficientes layouts o layouts correctos definidos aún. Serán soportados en el futuro.
29
30## Nombre del keymap
31
32Llama a este keymap como quieras.
33
34?> Si estás teniendo problemas para compilar, puede merecer la pena probar un cambio de nombre, ya que puede que ya exista en el repositorio de QMK Firmware.
35
36## Creando Tu keymap
37
38La adición de keycodes se puede hacer de 3 maneras.
391. Arrastrando y soltando
402. Clickando en un hueco vacío en el layout y haciendo click en el keycode que deseas
413. Clickando en un hueco vacío en el layout, presionando la tecla física en tu teclado.
42
43Mueve el puntero de tu ratón sobre una tecla y un pequeño extracto te dirá que es lo que hace la tecla. Para una descripción más detallada por favor, mira
44
45[Referencia básica de keycodes](https://docs.qmk.fm/#/keycodes_basic)
46[Referencia avanzada de keycodes](https://docs.qmk.fm/#/feature_advanced_keycodes)
47
48En el caso de que no puedas encontrar un layout que suporte tu keymap, por ejemplo, tres huecos para la barra espaciadora, dos huecos para el retroceso o dos huecos para shift etc etc, rellènalos TODOS.
49
50### Ejemplo:
51
523 huecos para barra espaciadora: Rellena TODOS con barra espaciadora
53
542 huecos para retroceso: Rellena AMBOS con retroceso
55
562 huecos para el shift derecho: Rellena AMBOS con shift derecho
57
581 hueco para el shift izquierdo y 1 hueco para soporte iso: Rellena ambos con el shift izquierdo
59
605 huecos , pero sólo 4 teclas: Intuye y comprueba o pregunta a alguien que lo haya hecho anteriormente.
61
62## Guardando tu keymap para ediciones futuras
63
64Cuando estés satisfecho con un teclado o quieres trabajar en el después, pulsa el botón `Exportar Keymap`. Guardára tu keymap con el nombre que elijas seguido de .json.
65
66Entonces podrás cargar este fichero .json en el futuro pulsando el botón `Importar Keymap`.
67
68!> **PRECAUCIÓN:** No es el mismo tipo de fichero .json usado en kbfirmware.com ni ninguna otra herramienta. Si intentas utilizar un fichero .json de alguna de estas herramientas con el Configurador QMK, existe la posibilidad de que tu teclado **explote**.
69
70## Generando tu fichero de firmware
71
72Pulsa el botón verde `Compilar`.
73
74Cuando la compilación haya acabado, podrás presionar el botón verde `Descargar Firmware`.
75
76## Flasheando tu teclado
77
78Por favor, dirígete a la sección de [Flashear firmware](newbs_flashing.md)
79
80## Problemas comunes
81
82#### Mi fichero .json no funciona
83
84Si el fichero .json fue generado con el Configurador QMK, enhorabuena, has dado con un bug. Abre una issue en [qmk_configurator](https://github.com/qmk/qmk_configurator/issues)
85
86Si no....cómo no viste el mensaje en negrita que puse arriba diciendo que no hay que utilizar otros ficheros .json?
87
88#### Hay espacios extra en mi layout ¿Qué hago?
89
90Si te refieres a tener tres espacios para la barra espaciadora, la mejor decisión es rellenar los tres con la barra espaciadora. También se puede hacer lo mismo con las teclas retroceso y las de shift
91
92#### Para qué sirve el keycode.......
93
94Por favor, mira
95
96[Referencia básica de keycodes](https://docs.qmk.fm/#/keycodes_basic)
97[Referencia avanzada de keycodes](https://docs.qmk.fm/#/feature_advanced_keycodes)
98
99#### No compila
100
101Por favor, revisa las otras capas de tu keymap para asegurarte de que no hay teclas aleatorias presentes.
102
103## Problemas y bugs
104
105Siempre aceptamos peticiones de clientes y reportes de bug. Por favor, indícalos en [qmk_configurator](https://github.com/qmk/qmk_configurator/issues)
diff --git a/docs/es/newbs_flashing.md b/docs/es/newbs_flashing.md
deleted file mode 100644
index 066715c48..000000000
--- a/docs/es/newbs_flashing.md
+++ /dev/null
@@ -1,351 +0,0 @@
1# Flasheando tu teclado
2
3Ahora que has construido tu fichero de firmware personalizado querrás flashear tu teclado.
4
5## Flasheando tu teclado con QMK Toolbox
6
7La manera más simple de flashear tu teclado sería con [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases).
8
9De todos modos, QMK Toolbox actualmente sólo está disponible para Windows y macOS. Si estás usando Linux (o sólo quisieras flashear el firmware desde la línea de comandos), tendrás que utilizar el [método indicado abajo](newbs_flashing.md#flash-your-keyboard-from-the-command-line).
10
11### Cargar el fichero en QMK Toolbox
12
13Empieza abriendo la aplicación QMK Toolbox. Tendrás que buscar el fichero de firmware usando Finder o Explorer. El firmware de teclado puede estar en uno de estos dos formatos- `.hex` o `.bin`. QMK intenta copiar el apropiado para tu teclado en el fichero raíz `qmk_firmware`.
14
15?> Si tu estás on Windows o macOS hay comandos que puedes usar para abrir fácilmente la carpeta del firmware actual en Explorer o Finder.
16
17?> Windows:
18
19 start .
20
21?> macOS:
22
23 open .
24
25El fichero de firmware sempre sigue el siguiente formato de nombre:
26
27 <nombre_teclado>_<nombre_keymap>.{bin,hex}
28
29Por ejemplo, un `plank/rev5` con un keymap `default` tendrá este nombre de fichero:
30
31 planck_rev5_default.hex
32
33Una vez que hayas localizado el fichero de tu firmware arrástralo a la caja "Fichero local" en QMK Toolbox, o haz click en "Abrir" y navega allí donde tengas almacenado tu fichero de firmware.
34
35### Pon tu teclado en modo DFU (Bootloader)
36
37Para poder flashear tu firmware personalizado tienes que poner tu teclado en un modo especial que permite flasheado. Cuando está en este modo no podrás teclear o utilizarlo para ninguna otra cosa. Es muy importante que no desconectes tu teclado, de lo contrario interrumpirás el proceso de flasheo mientras el firmware se está escribiendo.
38
39Diferentes teclados tienen diferentes maneras de entrar en este modo especial. Si tu PCB actualmente ejecuta QMK o TMK y no has recibido instrucciones específicas, intenta los siguientes pasos en orden:
40
41* Manten pulsadas ambas teclas shift y pulsa `Pause`
42* Manten pulsadas ambas teclas shift y pulsa `B`
43* Desconecta tu teclado, mantén pulsada la barra espaciadora y `B` al mismo tiempo, conecta tu teclado y espera un segundo antes de dejar de pulsar las teclas
44* Pulsa el botón físico `RESET` situado en el fondo de la PCB
45* Localiza los pines en la PCB etiquetados on `BOOT0` o `RESET`, puentea estos dos juntos cuando enchufes la PCB
46
47Si has tenido éxito verás un mensaje similar a este en QMK Toolbox:
48
49```
50*** Clueboard - Clueboard 66% HotSwap disconnected -- 0xC1ED:0x2390
51*** DFU device connected
52```
53
54### Flashea tu teclado
55
56Haz click en el botón `Flash` de QMK Toolbox. Verás una información de salida similar a esta:
57
58```
59*** Clueboard - Clueboard 66% HotSwap disconnected -- 0xC1ED:0x2390
60*** DFU device connected
61*** Attempting to flash, please don't remove device
62>>> dfu-programmer atmega32u4 erase --force
63 Erasing flash... Success
64 Checking memory from 0x0 to 0x6FFF... Empty.
65>>> dfu-programmer atmega32u4 flash /Users/skully/qmk_firmware/clueboard_66_hotswap_gen1_skully.hex
66 Checking memory from 0x0 to 0x55FF... Empty.
67 0% 100% Programming 0x5600 bytes...
68 [>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>] Success
69 0% 100% Reading 0x7000 bytes...
70 [>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>] Success
71 Validating... Success
72 0x5600 bytes written into 0x7000 bytes memory (76.79%).
73>>> dfu-programmer atmega32u4 reset
74
75*** DFU device disconnected
76*** Clueboard - Clueboard 66% HotSwap connected -- 0xC1ED:0x2390
77```
78
79## Flashea tu teclado desde la línea de comandos
80
81Lo primero que tienes que saber es qué bootloader utiliza tu teclado. Hay cuatro bootloaders pincipales que se usan habitualmente . Pro-Micro y sus clones usan CATERINA, Teensy's usa Halfkay, las placas OLKB usan QMK-DFU, y otros chips atmega32u4 usan DFU.
82
83Puedes encontrar más información sobre bootloaders en la página [Instrucciones de flasheado e información de Bootloader](flashing.md).
84
85Si sabes qué bootloader estás usando, en el momento de compilar el firmware, podrás añadir algún texto extra al comando `make` para automatizar el proceso de flasheado.
86
87### DFU
88
89Para eo bootloader DFU, cuando estés listo para compilar y flashear tu firmware, abre tu ventana de terminal y ejecuta el siguiente comando de construcción:
90
91 make <my_keyboard>:<my_keymap>:dfu
92
93Por ejemplo, si tu keymap se llama "xyverz" y estás construyendo un keymap para un planck rev5, utilizarás este comando:
94
95 make planck/rev5:xyverz:dfu
96
97Una vez que finalice de compilar, deberá aparecer lo siguiente:
98
99```
100Linking: .build/planck_rev5_xyverz.elf [OK]
101Creating load file for flashing: .build/planck_rev5_xyverz.hex [OK]
102Copying planck_rev5_xyverz.hex to qmk_firmware folder [OK]
103Checking file size of planck_rev5_xyverz.hex
104 * File size is fine - 18574/28672
105 ```
106
107Después de llegar a este punto, el script de construcción buscará el bootloader DFU cada 5 segundos. Repetirá lo siguiente hasta que se encuentre el dispositivo o lo canceles:
108
109 dfu-programmer: no device present.
110 Error: Bootloader not found. Trying again in 5s.
111
112Una vez haya hecho esto, tendrás que reiniciar el controlador. Debería mostrar una información de salida similar a esta:
113
114```
115*** Attempting to flash, please don't remove device
116>>> dfu-programmer atmega32u4 erase --force
117 Erasing flash... Success
118 Checking memory from 0x0 to 0x6FFF... Empty.
119>>> dfu-programmer atmega32u4 flash /Users/skully/qmk_firmware/clueboard_66_hotswap_gen1_skully.hex
120 Checking memory from 0x0 to 0x55FF... Empty.
121 0% 100% Programming 0x5600 bytes...
122 [>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>] Success
123 0% 100% Reading 0x7000 bytes...
124 [>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>] Success
125 Validating... Success
126 0x5600 bytes written into 0x7000 bytes memory (76.79%).
127>>> dfu-programmer atmega32u4 reset
128```
129
130?> Si tienes problemas con esto- del estilo de `dfu-programmer: no device present` - por favor consulta las [Preguntas frecuentes de construcción](faq_build.md).
131
132#### Comandos DFU
133
134Hay un número de comandos DFU que puedes usar para flashear firmware a un dispositivo DFU:
135
136* `:dfu` - Esta es la opción normal y espera hasta que un dispositivo DFU esté disponible, entonces flashea el firmware. Esperará reintentando cada 5 segundos, para ver si un dispositivo DFU ha aparecido.
137* `:dfu-ee` - Esta flashea un fichero `eep` en vez del hex normal. Esto no es lo común.
138* `:dfu-split-left` - Esta flashea el firmware normal, igual que la opción por defecto (`:dfu`). Sin embargo, también flashea el fichero EEPROM "Lado Izquierdo" para teclados divididos. _Esto es ideal para los ficheros divididos basados en Elite C._
139* `:dfu-split-right` - Esto flashea el firmware normal, igual que la opción por defecto (`:dfu`). Sin embargo, también flashea el fichero EEPROM "Lado Derecho" para teclados divididos. _Esto es ideal para los ficheros divididos basados en Elite C._
140
141
142### Caterina
143
144Para placas Arduino y sus clones (como la SparkFun ProMicro), cuando estés listo para compilar y flashear tu firmware, abre tu ventana de terminal y ejecuta el siguiente comando de construcción:
145
146 make <my_keyboard>:<my_keymap>:avrdude
147
148Por ejemplo, si tu keymap se llama "xyverz" y estás construyendo un keymap para un Lets Split rev2, usarás este comando:
149
150 make lets_split/rev2:xyverz:avrdude
151
152Una vez que finalice de compilar, deberá aparecer lo siguiente:
153
154```
155Linking: .build/lets_split_rev2_xyverz.elf [OK]
156Creating load file for flashing: .build/lets_split_rev2_xyverz.hex [OK]
157Checking file size of lets_split_rev2_xyverz.hex [OK]
158 * File size is fine - 27938/28672
159Detecting USB port, reset your controller now..............
160```
161
162En este punto, reinicia la placa y entonces el script detectará el bootloader y procederá a flashear la placa. La información de salida deber ser algo similar a esto:
163
164```
165Detected controller on USB port at /dev/ttyS15
166
167Connecting to programmer: .
168Found programmer: Id = "CATERIN"; type = S
169 Software Version = 1.0; No Hardware Version given.
170Programmer supports auto addr increment.
171Programmer supports buffered memory access with buffersize=128 bytes.
172
173Programmer supports the following devices:
174 Device code: 0x44
175
176avrdude.exe: AVR device initialized and ready to accept instructions
177
178Reading | ################################################## | 100% 0.00s
179
180avrdude.exe: Device signature = 0x1e9587 (probably m32u4)
181avrdude.exe: NOTE: "flash" memory has been specified, an erase cycle will be performed
182 To disable this feature, specify the -D option.
183avrdude.exe: erasing chip
184avrdude.exe: reading input file "./.build/lets_split_rev2_xyverz.hex"
185avrdude.exe: input file ./.build/lets_split_rev2_xyverz.hex auto detected as Intel Hex
186avrdude.exe: writing flash (27938 bytes):
187
188Writing | ################################################## | 100% 2.40s
189
190avrdude.exe: 27938 bytes of flash written
191avrdude.exe: verifying flash memory against ./.build/lets_split_rev2_xyverz.hex:
192avrdude.exe: load data flash data from input file ./.build/lets_split_rev2_xyverz.hex:
193avrdude.exe: input file ./.build/lets_split_rev2_xyverz.hex auto detected as Intel Hex
194avrdude.exe: input file ./.build/lets_split_rev2_xyverz.hex contains 27938 bytes
195avrdude.exe: reading on-chip flash data:
196
197Reading | ################################################## | 100% 0.43s
198
199avrdude.exe: verifying ...
200avrdude.exe: 27938 bytes of flash verified
201
202avrdude.exe: safemode: Fuses OK (E:CB, H:D8, L:FF)
203
204avrdude.exe done. Thank you.
205```
206Si tienes problemas con esto, puede ser necesario que hagas esto:
207
208 sudo make <my_keyboard>:<my_keymap>:avrdude
209
210
211Adicionalmente, si quisieras flashear múltiples placas, usa el siguiente comando:
212
213 make <keyboard>:<keymap>:avrdude-loop
214
215Cuando hayas acabado de flashear placas, necesitarás pulsar Ctrl + C o cualquier combinación que esté definida en tu sistema operativo para finalizar el bucle.
216
217
218### HalfKay
219
220Para dispositivos PJRC (Teensy's), cuando estés listo para compilar y flashear tu firmware, abre tu ventana de terminal y ejecuta el siguiente comando de construcción:
221
222 make <my_keyboard>:<my_keymap>:teensy
223
224Por ejemplo, si tu keymap se llama "xyverz" y estás construyendo un keymap para un Ergodox o un Ergodox EZ, usarás este comando:
225
226 make ergodox_ez:xyverz:teensy
227
228Una vez que el firmware acabe de compilar, deberá mostrar una información de salida como esta:
229
230```
231Linking: .build/ergodox_ez_xyverz.elf [OK]
232Creating load file for flashing: .build/ergodox_ez_xyverz.hex [OK]
233Checking file size of ergodox_ez_xyverz.hex [OK]
234 * File size is fine - 25584/32256
235 Teensy Loader, Command Line, Version 2.1
236Read "./.build/ergodox_ez_xyverz.hex": 25584 bytes, 79.3% usage
237Waiting for Teensy device...
238 (hint: press the reset button)
239 ```
240
241En este punto, reinicia tu placa. Una vez que lo hayas hecho, deberás ver una información de salida como esta:
242
243 ```
244 Found HalfKay Bootloader
245Read "./.build/ergodox_ez_xyverz.hex": 28532 bytes, 88.5% usage
246Programming............................................................................................................................................................................
247...................................................
248Booting
249```
250
251### BootloadHID
252
253Para placas basadas en Bootmapper Client(BMC)/bootloadHID/ATmega32A, cuando estés listo para compilar y flashear tu firmware, abre tu ventana de terminal y ejecuta el comando de construcción:
254
255 make <my_keyboard>:<my_keymap>:bootloaderHID
256
257Por ejemplo, si tu keymap se llama "xyverz" y estás construyendo un keymap para un jj40, usarás esté comando:
258
259 make jj40:xyverz:bootloaderHID
260
261Una vez que el firmware acaba de compilar, mostrará una información de salida como esta:
262
263```
264Linking: .build/jj40_default.elf [OK]
265Creating load file for flashing: .build/jj40_default.hex [OK]
266Copying jj40_default.hex to qmk_firmware folder [OK]
267Checking file size of jj40_default.hex [OK]
268 * The firmware size is fine - 21920/28672 (6752 bytes free)
269```
270
271Después de llegar a este punto, el script de construcción buscará el bootloader DFU cada 5 segundos. Repetirá lo siguiente hasta que se encuentre el dispositivo o hasta que lo canceles.
272
273```
274Error opening HIDBoot device: The specified device was not found
275Trying again in 5s.
276```
277
278Una vez que lo haga, querrás reinicar el controlador. Debería entonces mostrar una información de salida similar a esta:
279
280```
281Page size = 128 (0x80)
282Device size = 32768 (0x8000); 30720 bytes remaining
283Uploading 22016 (0x5600) bytes starting at 0 (0x0)
2840x05580 ... 0x05600
285```
286
287### STM32 (ARM)
288
289Para la mayoría de placas ARM (incluyendo la Proton C, Planck Rev 6, y Preonic Rev 3), cuando estés listo para compilar y flashear tu firmware, abre tu ventana de terminal y ejecuta el siguiente comando de construcción:
290
291 make <my_keyboard>:<my_keymap>:dfu-util
292
293Por ejemplo, si tu keymap se llama "xyverz" y estás construyendo un keymap para un teclado Planck Revision 6, utilizarás este comando y a continuación reiniciarás el teclado con el bootloader (antes de que acabe de compilar):
294
295 make planck/rev6:xyverz:dfu-util
296
297Una vez que el firmware acaba de compilar, mostrará una información de salida similar a esta:
298
299```
300Linking: .build/planck_rev6_xyverz.elf [OK]
301Creating binary load file for flashing: .build/planck_rev6_xyverz.bin [OK]
302Creating load file for flashing: .build/planck_rev6_xyverz.hex [OK]
303
304Size after:
305 text data bss dec hex filename
306 0 41820 0 41820 a35c .build/planck_rev6_xyverz.hex
307
308Copying planck_rev6_xyverz.bin to qmk_firmware folder [OK]
309dfu-util 0.9
310
311Copyright 2005-2009 Weston Schmidt, Harald Welte and OpenMoko Inc.
312Copyright 2010-2016 Tormod Volden and Stefan Schmidt
313This program is Free Software and has ABSOLUTELY NO WARRANTY
314Please report bugs to http://sourceforge.net/p/dfu-util/tickets/
315
316Invalid DFU suffix signature
317A valid DFU suffix will be required in a future dfu-util release!!!
318Opening DFU capable USB device...
319ID 0483:df11
320Run-time device DFU version 011a
321Claiming USB DFU Interface...
322Setting Alternate Setting #0 ...
323Determining device status: state = dfuERROR, status = 10
324dfuERROR, clearing status
325Determining device status: state = dfuIDLE, status = 0
326dfuIDLE, continuing
327DFU mode device DFU version 011a
328Device returned transfer size 2048
329DfuSe interface name: "Internal Flash "
330Downloading to address = 0x08000000, size = 41824
331Download [=========================] 100% 41824 bytes
332Download done.
333File downloaded successfully
334Transitioning to dfuMANIFEST state
335```
336
337#### STM32 Commands
338
339Hay un número de comandos DFU que puedes usar para flashear firmware a un dispositivo DFU:
340
341* `:dfu-util` - El comando por defecto para flashing en dispositivos STM32.
342* `:dfu-util-wait` - Esto funciona como el comando por defecto, pero te da (configurable) 10 segundos de tiempo antes de que intente flashear el firmware. Puedes usar `TIME_DELAY=20` desde la líena de comandos para cambiar este tiempo de retardo.
343 * Eg: `make <keyboard>:<keymap>:dfu-util TIME_DELAY=5`
344* `:dfu-util-split-left` - Flashea el firmware normal, igual que la opción por defecto (`:dfu-util`). Sin embargo, también flashea el fichero EEPROM "Lado Izquierdo" para teclados divididos.
345* `:dfu-util-split-right` - Flashea el firmware normal, igual que la opción por defecto (`:dfu-util`). Sin embargo, también flashea el fichero EEPROM "Lado Derecho" para teclados divididos.
346
347## ¡Pruébalo!
348
349¡Felicidades! ¡Tu firmware personalizado ha sido programado en tu teclado!
350
351Pruébalo y asegúrate de que todo funciona de la manera que tu quieres. Hemos escrito [Testeando y depurando](newbs_testing_debugging.md) para redondear esta guía de novatos, así que pásate por allí para aprender cómo resolver problemas con tu funcionalidad personalizada.
diff --git a/docs/es/newbs_getting_started.md b/docs/es/newbs_getting_started.md
deleted file mode 100644
index 046fdee27..000000000
--- a/docs/es/newbs_getting_started.md
+++ /dev/null
@@ -1,103 +0,0 @@
1# Introducción
2
3El teclado de tu computador tiene un procesador dentro de él, no muy distinto del que está dentro de tu ordenador. Este procesador ejecuta software que es responsable de detectar la pulsación de las teclas y enviar informes sobre el estado del teclado cuando las teclas son pulsadas y liberadas. QMK ocupa el rol de ese software. Cuando construyes un keymap personalizado , estas creando el equivalente de un programa ejecutable en tu teclado.
4
5QMK intenta poner un montón de poder en tus manos haciendo que las cosas fáciles sean fáciles, y las cosas difíciles posibles. No tienes que saber cómo programar para crear keymaps potentes — sólo tienes que seguir un conjunto simple de reglas sintácticas.
6
7# Comenzando
8
9Antes de que puedas construir keymaps, necesitarás instalar algun software y configurar tu entorno de construcción. Esto sólo hay que hacerlo una vez sin importar en cuántos teclados planeas configurar el software.
10
11Si prefieres hacerlo mediante un interfaz gráfico , por favor, considera utilizar el [Configurador QMK](https://config.qmk.fm). En ese caso dirígete a [Construyendo tu primer firmware usando la GUI](newbs_building_firmware_configurator.md).
12
13
14## Descarga el software
15
16### Editor de texto
17
18Necesitarás un programa con el que puedas editar y guardar archivos de **texto plano**, en windows puedes utilizar Notepad y en tu Linux puedes utilizar gedit. Estos dos programas son editores simples y funcionales. En macOS ten cuidado con la aplicación de edición de texto por defecto TextEdit: no guardará texto plano a menos de que se le seleccione explícitamente _Make Plain Text_ desde el menú _Format_.
19
20También puedes descargar e instalar un editor de texto dedicado como [Sublime Text](https://www.sublimetext.com/) o [VS Code](https://code.visualstudio.com/). Esta es probablemente la mejor manera independientemente de la plataforma, ya que estos programas fueron creados específicamente para editar código.
21
22?> ¿No estás seguro de qué editor de texto utilizar? Laurence Bradford escribió una [estupenda introducción](https://learntocodewith.me/programming/basics/text-editors/) al tema.
23
24### QMK Toolbox
25
26QMK Toolbox is an optional graphical program for Windows and macOS that allows you to both program and debug your custom keyboard. You will likely find it invaluable for easily flashing your keyboard and viewing debug messages that it prints.
27
28[Download the latest release here.](https://github.com/qmk/qmk_toolbox/releases/latest)
29
30* For Windows: `qmk_toolbox.exe` (portable) or `qmk_toolbox_install.exe` (installer)
31* For macOS: `QMK.Toolbox.app.zip` (portable) or `QMK.Toolbox.pkg` (installer)
32
33## Configura tu entorno
34
35Hemos intentado hacer QMK lo más fácil de configurar posible. Sólo tienes que preparar tu entorno Linux o Unix, y luego dejar que QMK
36instale el resto.
37
38?> Si no has trabajado con la línea de comandos de Linux/Unix con anterioridad, hay algunos conceptos y comandos básicos que deberías aprender. Estos recursos te enseñarán lo suficiente para poder trabajar con QMK:<br>
39[Comandos de Linux que debería saber](https://www.guru99.com/must-know-linux-commands.html)<br>
40[Algunos comandos básicos de Unix](https://www.tjhsst.edu/~dhyatt/superap/unixcmd.html)
41
42### Windows
43
44Necesitarás instalar MSYS2 y Git.
45
46* Sigue las instrucciones de instalación en la [página de MSYS2](https://www.msys2.org).
47* Cierra las terminales abiertas de MSYS2 y abre una nueva termial de MSYS2 MinGW 64-bit.
48* Instala Git ejecutando este comando: `pacman -S git`.
49
50### macOS
51
52Necesitarás instalar Homebrew. Sigue las instrucciones que encontrarás en la [página de Homebrew](https://brew.sh).
53
54Despueś de que se haya inastalado Homebrew, continúa con _Set Up QMK_. En ese paso ejecutará un script que instalará el resto de paquetes.
55
56### Linux
57
58Necesitarás instalar Git. Es bastante probable que ya lo tengas, pero si no, uno de los siguientes comandos debería instalarlo:
59
60* Debian / Ubuntu / Devuan: `apt-get install git`
61* Fedora / Red Hat / CentOS: `yum install git`
62* Arch: `pacman -S git`
63
64?> Docker es también una opción en todas las plataformas. [Haz click aquí si quieres detalles.](getting_started_build_tools.md#docker)
65
66## Configura QMK
67
68Una vez que hayas configurado tu entorno Linux/Unix, estarás listo para descargar QMK. Haremos esto utilizando Git para "clonar" el respositorio de QMK. Abre una ventana de Terminal o MSYS2 MinGW y mantenla abierta mientras sigues esta guía. Dentro de esa ventana ejecuta estos dos comandos:
69
70```shell
71git clone --recurse-submodules https://github.com/qmk/qmk_firmware.git
72cd qmk_firmware
73```
74
75?> Si ya sabes [cómo usar GitHub](getting_started_github.md), te recomendamos en vez de eso, crees y clones tu propio fork. Si no sabes lo que significa, puedes ignorar este mensaje sin problemas.
76
77QMK viene con un script para ayudarte a configurar el resto de cosas que necesitarás. Deberías ejecutarlo introduciendo este comando:
78
79 util/qmk_install.sh
80
81## Prueba tu entorno de construcción
82
83Ahora que tu entorno de construcción de QMK está configurado, puedes construcir un firmware para tu teclado. Comienza intentado construir el keymap por defecto del teclado. Deberías ser capaz de hacerlo con un comando con este formato:
84
85 make <keyboard>:default
86
87Por ejemplo, para construir el firmware para un Clueboard 66% deberías usar:
88
89 make clueboard/66/rev3:default
90
91Cuando esté hecho, deberías tener un montón de información de salida similar a esta:
92
93```
94Linking: .build/clueboard_66_rev3_default.elf [OK]
95Creating load file for flashing: .build/clueboard_66_rev3_default.hex [OK]
96Copying clueboard_66_rev3_default.hex to qmk_firmware folder [OK]
97Checking file size of clueboard_66_rev3_default.hex [OK]
98 * The firmware size is fine - 26356/28672 (2316 bytes free)
99```
100
101# Creando tu keymap
102
103Ya estás listo para crear tu propio keymap personal! Para hacerlo continua con [Construyendo tu primer firmware](newbs_building_firmware.md).
diff --git a/docs/es/newbs_learn_more_resources.md b/docs/es/newbs_learn_more_resources.md
deleted file mode 100644
index 34fd7556b..000000000
--- a/docs/es/newbs_learn_more_resources.md
+++ /dev/null
@@ -1,15 +0,0 @@
1# Recursos de aprendizaje
2
3Estos recursos procuran dar miembros nuevos en la communidad QMK un mayor entendimiento de la información proporcionada en la documentación para novatos.
4
5Recursos de Git:
6
7* [Excelente tutorial general](https://www.codecademy.com/learn/learn-git)
8* [Juego de Git para aprender usando ejemplos](https://learngitbranching.js.org/)
9* [Recursos de Git para aprender más sobre GitHub](getting_started_github.md)
10* [Recursos de Git dirigidos específicamente a QMK](contributing.md)
11
12
13Recursos para línea de mandatos:
14
15* [Excelente tutorial general sobre la línea de mandatos](https://www.codecademy.com/learn/learn-the-command-line)
diff --git a/docs/es/newbs_testing_debugging.md b/docs/es/newbs_testing_debugging.md
deleted file mode 100644
index 69f698465..000000000
--- a/docs/es/newbs_testing_debugging.md
+++ /dev/null
@@ -1,101 +0,0 @@
1# Testeando y depurando
2
3Una vez que hayas flasheado tu teclado con un firmware personalizado estarás listo para probarlo. Con un poco de suerte todo funcionará a la primera, pero si no es así, este documento te ayudará a averiguar qué está mal.
4
5## Probando
6
7Probar tu teclado es generalmente bastante sencillo. Persiona cada una de las teclas y asegúrate de que envía la tecla correcta. Existen incluso programas que te ayudarán a asegurarte de que no te dejas ninguna tecla sin comprobar.
8
9Nota: Estos programas no los provée ni están relacionados con QMK.
10
11* [Switch Hitter](https://elitekeyboards.com/switchhitter.php) (Sólo Windows)
12* [Keyboard Viewer](https://www.imore.com/how-use-keyboard-viewer-your-mac) (Sólo Mac)
13* [Keyboard Tester](https://www.keyboardtester.com) (Aplicación web)
14* [Keyboard Checker](https://keyboardchecker.com) (Aplicación web)
15
16## Depurando
17
18Tu teclado mostrará información de depuración si tienes `CONSOLE_ENABLE = yes` en tu `rules.mk`. Por defecto la información de salida es muy limitada, pero puedes encender el modo de depuración para incrementar la información de salida. Utiliza el keycode `DEBUG` de tu keymap, usa la característica [Comando](feature_command.md) para activar el modo depuración, o añade el siguiente código a tu keymap.
19
20```c
21void keyboard_post_init_user(void) {
22 // Customise these values to desired behaviour
23 debug_enable=true;
24 debug_matrix=true;
25 //debug_keyboard=true;
26 //debug_mouse=true;
27}
28```
29
30### Depurando con QMK Toolbox
31
32Para plataformas compatibles, [QMK Toolbox](https://github.com/qmk/qmk_toolbox) se puede usar para mostrar mensajes de depuración de tu teclado.
33
34### Depurando con hid_listen
35
36¿Prefieres una solución basada en una terminal? [hid_listen](https://www.pjrc.com/teensy/hid_listen.html), provista por PJRC, se puede usar también para mostrar mensajes de depuración. Hay binarios preconstruídos para Windows,Linux,y MacOS.
37
38<!-- FIXME: Describe the debugging messages here. -->
39
40## Enviando tus propios mensajes de depuración
41
42A veces, es útil imprimir mensajes de depuración desde tu [código personalizado](custom_quantum_functions.md). Hacerlo es bastante simple. Comienza incluyendo `print.h` al principio de tu fichero:
43
44```c
45#include "print.h"
46```
47
48Después de eso puedes utilzar algunas funciones print diferentes:
49
50* `print("string")`: Imprime un string simple
51* `uprintf("%s string", var)`: Imprime un string formateado
52* `dprint("string")` Imprime un string simple, pero sólo cuando el modo de depuración está activo
53* `dprintf("%s string", var)`: Imprime un string formateado, pero sólo cuando el modo de depuración está activo
54
55## Ejemplos de depuración
56
57Debajo hay una colección de ejemplos de depuración del mundo real. Para información adicional, Dirígete a [Depurando/Encontrando problemas en QMK](faq_debug.md).
58
59### ¿Que posición en la matriz tiene esta pulsación de tecla?
60
61Cuando estés portando, o intentando diagnosticar problemas en la pcb, puede ser útil saber si la pulsación de una tecla es escaneada correctamente. Para hablitar la información de registro en este escenario, añade el siguiente código al `keymap.c` de tus keymaps
62
63```c
64bool process_record_user(uint16_t keycode, keyrecord_t *record) {
65 // If console is enabled, it will print the matrix position and status of each key pressed
66#ifdef CONSOLE_ENABLE
67 uprintf("KL: kc: %u, col: %u, row: %u, pressed: %u\n", keycode, record->event.key.col, record->event.key.row, record->event.pressed);
68#endif
69 return true;
70}
71```
72
73Ejemplo de salida
74```text
75Waiting for device:.......
76Listening:
77KL: kc: 169, col: 0, row: 0, pressed: 1
78KL: kc: 169, col: 0, row: 0, pressed: 0
79KL: kc: 174, col: 1, row: 0, pressed: 1
80KL: kc: 174, col: 1, row: 0, pressed: 0
81KL: kc: 172, col: 2, row: 0, pressed: 1
82KL: kc: 172, col: 2, row: 0, pressed: 0
83```
84
85### ¿Cuanto tiempo tardó en escanear la pulsación de una tecla?
86
87Cuando estés probando problemas en el rendimiento, puede ser útil saber la frecuenta a la cual la matríz de pulsadores se está escaneando. Para hablitar la información de registro en este escenario, añade el siguiente código al `config.h` de tus keymaps
88
89```c
90#define DEBUG_MATRIX_SCAN_RATE
91```
92
93Ejemplo de salida
94```text
95 > matrix scan frequency: 315
96 > matrix scan frequency: 313
97 > matrix scan frequency: 316
98 > matrix scan frequency: 316
99 > matrix scan frequency: 316
100 > matrix scan frequency: 316
101```
diff --git a/docs/fr-fr/ChangeLog/20190830.md b/docs/fr-fr/ChangeLog/20190830.md
deleted file mode 100644
index cb223be31..000000000
--- a/docs/fr-fr/ChangeLog/20190830.md
+++ /dev/null
@@ -1,52 +0,0 @@
1# QMK Breaking Change - 30 août 2019
2
3Quatre 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.
4
5Ce document présente les fusions de Breaking Change. Voici la liste des changements.
6
7## Formattage de code Core avec clang-format
8
9* Tous les fichiers core (`drivers/`, `quantum/`, `tests/`, et `tmk_core/`) seront formatés avec clang-format
10* Un processus travis pour reformatter les PRs lors de la fusion a été mis en place
11* Vous pouvez utiliser la nouvelle commande CLI `qmk cformat` afin de formater avant de soumettre votre PR si vous le souhaitez.
12
13## Nettoyage des descripteurs LUFA USB
14
15* Nettoyage du code lié aux descripteurs USB HID sur les claviers AVR, afin de les rendre plus simple à lire et compréhensibles
16* Plus d'information: https://github.com/qmk/qmk_firmware/pull/4871
17* Normalement pas de changement de fonctionnement et aucune keymap modifiée.
18
19## Migration des entrées de `ACTION_LAYER_MOMENTARY()` dans `fn_actions` vers des keycodes `MO()`
20
21* `fn_actions` est déprécié, et ses fonctionnalités ont été remplacées par des keycodes directs et `process_record_user()`
22* Supprimer cette fonctionnalité obsolète devrait aboutir à une réduction importante de la taille du firmware et de la complexité du code
23* 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)
24
25## Mise à jour Atreus vers les conventions de codage courantes
26
27* Les doublons include guards ont contourné le comportement de traitement des headers attendu
28* Il est recommandé pour toutes les keymaps affectées de supprimer le doublon de `<keyboard>/config.h` et `<keyboard>/keymaps/<user>/config.h` et de ne garder que des surcharges au niveau keymap
29
30## Récupération des changements de fichier keymap langage de la fork ZSA
31
32* Corrige une issue dans le fichier `keymap_br_abnt2.h` qui inclut la mauvaise souce (`keymap_common.h` au lieu de `keymap.h`)
33* Met à jour le fichier `keymap_swedish.h` afin d'être spécifique au suédois et plus "nordique" en général.
34* Toutes les keymaps qui utilisent ceci devront supprimer `NO_*` et le remplacer par `SE_*`.
35
36## Mise à jour du repo afin d'utiliser LUFA comme un sous-module git
37
38* `/lib/LUFA` supprimé du dépôt
39* LUFA, définis comme un sous-module, pointe vers qmk/lufa
40* 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.
41
42## Migration des entrées `ACTION_BACKLIGHT_*()` dans `fn_actions` vers des keycodes `BL_`
43
44* `fn_actions` est déprécié, et ses fonctionnalités ont été remplacées par des keycodes directs et `process_record_user()`
45* Toutes les keymaps utilisant ces actions doivent avoir les clés `KC_FN*` remplacées par les clés `BL_*` équivalentes
46* 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)
47
48## Remplacer l'alias `KC_DELT` par `KC_DEL`
49
50* `KC_DELT` était un alias redondant et non documenté pour `KC_DELETE`
51* Il a été supprimé et toutes ses utilisations ont été remplacées par l'alias plus courant `KC_DEL`
52* 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 3d1f740ab..000000000
--- a/docs/fr-fr/README.md
+++ /dev/null
@@ -1,31 +0,0 @@
1# Quantum Mechanical Keyboard Firmware
2
3[![Version courante](https://img.shields.io/github/tag/qmk/qmk_firmware.svg)](https://github.com/qmk/qmk_firmware/tags)
4[![Discord](https://img.shields.io/discord/440868230475677696.svg)](https://discord.gg/Uq7gcHh)
5[![Statut de la doc](https://img.shields.io/badge/docs-ready-orange.svg)](https://docs.qmk.fm)
6[![Contributeurs GitHub](https://img.shields.io/github/contributors/qmk/qmk_firmware.svg)](https://github.com/qmk/qmk_firmware/pulse/monthly)
7[![Forks GitHub](https://img.shields.io/github/forks/qmk/qmk_firmware.svg?style=social&label=Fork)](https://github.com/qmk/qmk_firmware/)
8
9## Qu'est-ce que QMK Firmware?
10
11QMK (*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](https://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](https://olkb.com), le clavier [ErgoDox EZ](https://www.ergodox-ez.com), et pour les [produits Clueboard](https://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é.
12
13## Comment l'obtenir
14
15Si 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.
16
17Sinon, 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`).
18
19## Comment le compiler
20
21Avant d'être prêt à compiler vous allez devoir [installer un environnement](fr-fr/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 :
22
23 make planck/rev4:default
24
25Cette 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:
26
27 make preonic:default
28
29## Comment le personnaliser
30
31QMK a beaucoup de [fonctionnalités](fr-fr/features.md) à explorer, et [une documentation](https://docs.qmk.fm) très abondante que vous pourrez parcourir. La plupart des fonctionnalités vous permettrons de modifier vos [dispositions](fr-fr/keymap.md) (keymaps) et de changer [les codes de caractères](fr-fr/keycodes.md) (keycodes).
diff --git a/docs/fr-fr/_summary.md b/docs/fr-fr/_summary.md
deleted file mode 100644
index 25a593b2e..000000000
--- a/docs/fr-fr/_summary.md
+++ /dev/null
@@ -1,126 +0,0 @@
1**En Français**
2
3* [Guide pour débutant complet](fr-fr/newbs.md)
4 * [Pour débuter](fr-fr/newbs_getting_started.md)
5 * [Compiler son premier firmware](fr-fr/newbs_building_firmware.md)
6 * [Flasher le Firmware](fr-fr/newbs_flashing.md)
7 * [Test et Débuggage](fr-fr/newbs_testing_debugging.md)
8 * [Bonnes pratiques Git](fr-fr/newbs_best_practices.md)
9 * [Ressources d'apprentissage](fr-fr/newbs_learn_more_resources.md)
10
11* [Les bases de QMK](fr-fr/README.md)
12 * [Indroduction à QMK](fr-fr/getting_started_introduction.md)
13 * [QMK CLI](fr-fr/cli.md)
14 * [Configuration de la CLI QMK](fr-fr/cli_configuration.md)
15 * [Contribuer à QMK](fr-fr/contributing.md)
16 * [Comment utiliser GitHub](fr-fr/getting_started_github.md)
17 * [Trouver de l'aide](fr-fr/getting_started_getting_help.md)
18
19* [Breaking changes](fr-fr/breaking_changes.md)
20 * [30 août 2019](fr-fr/ChangeLog/20190830.md)
21
22* [FAQ](fr-fr/faq.md)
23 * [FAQ Générale](fr-fr/faq_general.md)
24 * [Compiler QMK](fr-fr/faq_build.md)
25 * [Débugguer / Dépanner QMK](fr-fr/faq_debug.md)
26 * [Keymap / Disposition](fr-fr/faq_keymap.md)
27 * [Installer les drivers avec Zadig](fr-fr/driver_installation_zadig.md)
28
29**En Anglais**
30
31* Guides détaillés
32 * [Installation des outils de compilation](fr-fr/getting_started_build_tools.md)
33 * [Guide Vagrant](fr-fr/getting_started_vagrant.md)
34 * [Commandes de compilations](fr-fr/getting_started_make_guide.md)
35 * [Flasher les firmwares](fr-fr/flashing.md)
36 * [Personnaliser les fonctionnalités](fr-fr/custom_quantum_functions.md)
37 * [Aperçu des fonctionnalités des dispositions](fr-fr/keymap.md)
38
39* [Hardware](fr-fr/hardware.md)
40 * [Processeurs AVR](fr-fr/hardware_avr.md)
41 * [Pilotes / Drivers](fr-fr/hardware_drivers.md)
42
43* Réferences
44 * [Lignes de conduite des claviers](fr-fr/hardware_keyboard_guidelines.md)
45 * [Options de configurations](fr-fr/config_options.md)
46 * [Keycodes / Codes des caractères](fr-fr/keycodes.md)
47 * [Conventions de codage - C](fr-fr/coding_conventions_c.md)
48 * [Conventions de codage - Python](fr-fr/coding_conventions_python.md)
49 * [Meilleurs pratiques sur la documentation](fr-fr/documentation_best_practices.md)
50 * [Modèles de documentation](fr-fr/documentation_templates.md)
51 * [Glossaire](fr-fr/reference_glossary.md)
52 * [Tests unitaires](fr-fr/unit_testing.md)
53 * [Fonctions utiles](fr-fr/ref_functions.md)
54 * [Support de configuration](fr-fr/reference_configurator_support.md)
55 * [Format du fichier info.json](fr-fr/reference_info_json.md)
56 * [Développer la CLI en Python](fr-fr/cli_development.md)
57
58* [Fonctionnalités](fr-fr/features.md)
59 * [Keycodes basiques](fr-fr/keycodes_basic.md)
60 * [Touches utilisées avec Shift (US ANSI)](fr-fr/keycodes_us_ansi_shifted.md)
61 * [Keycodes quantiques](fr-fr/quantum_keycodes.md)
62 * [Keycodes avancés](fr-fr/feature_advanced_keycodes.md)
63 * [Fonctionnalités audio](fr-fr/feature_audio.md)
64 * [Majuscule automatique](fr-fr/feature_auto_shift.md)
65 * [Rétroéclairage](fr-fr/feature_backlight.md)
66 * [Bluetooth](fr-fr/feature_bluetooth.md)
67 * [Bootmagic](fr-fr/feature_bootmagic.md)
68 * [Combos](fr-fr/feature_combo.md)
69 * [Commande](fr-fr/feature_command.md)
70 * [API anti-rebond](fr-fr/feature_debounce_type.md)
71 * [DIP Switch](fr-fr/feature_dip_switch.md)
72 * [Macros dynamiques](fr-fr/feature_dynamic_macros.md)
73 * [Interrupteurs rotatifs](fr-fr/feature_encoders.md)
74 * [Grave Escape](fr-fr/feature_grave_esc.md)
75 * [Retour haptique](fr-fr/feature_haptic_feedback.md)
76 * [Contrôleur LCD HD44780](fr-fr/feature_hd44780.md)
77 * [Touche à verrou / Lock-key](fr-fr/feature_key_lock.md)
78 * [Dispositions / layouts](fr-fr/feature_layouts.md)
79 * [Touche leader](fr-fr/feature_leader_key.md)
80 * [Matrice LED](fr-fr/feature_led_matrix.md)
81 * [Macros](fr-fr/feature_macros.md)
82 * [Boutons de souris](fr-fr/feature_mouse_keys.md)
83 * [Pilotes / Drivers OLED](fr-fr/feature_oled_driver.md)
84 * [Touche one-shot](fr-fr/one_shot_keys.md)
85 * [Périphériques de pointage](fr-fr/feature_pointing_device.md)
86 * [Souris PS/2](fr-fr/feature_ps2_mouse.md)
87 * [Éclairage RGB](fr-fr/feature_rgblight.md)
88 * [Matrice RGB](fr-fr/feature_rgb_matrix.md)
89 * [Space Cadet](fr-fr/feature_space_cadet.md)
90 * [Claviers scindés / splittés](fr-fr/feature_split_keyboard.md)
91 * [Stenographie](fr-fr/feature_stenography.md)
92 * [Inversion des mains](fr-fr/feature_swap_hands.md)
93 * [Tap Dance](fr-fr/feature_tap_dance.md)
94 * [Terminale](fr-fr/feature_terminal.md)
95 * [Imprimante thermique](fr-fr/feature_thermal_printer.md)
96 * [Caractères unicodes](fr-fr/feature_unicode.md)
97 * [Dossier utilisateur](fr-fr/feature_userspace.md)
98 * [Velocikey](fr-fr/feature_velocikey.md)
99
100* Pour les makers et les bricoleurs
101 * [Guide des claviers soudés à la main](fr-fr/hand_wire.md)
102 * [Guide de flash de l’ISP](fr-fr/isp_flashing_guide.md)
103 * [Guide du débogage ARM](fr-fr/arm_debugging.md)
104 * [Drivers I2C](fr-fr/i2c_driver.md)
105 * [Drivers SPI](fr-fr/spi_driver.md)
106 * [Contrôles des GPIO](fr-fr/internals_gpio_control.md)
107 * [Conversion en Proton C](fr-fr/proton_c_conversion.md)
108
109* Pour aller plus loin
110 * [Comment fonctionnent les claviers](fr-fr/how_keyboards_work.md)
111 * [Comprendre QMK](fr-fr/understanding_qmk.md)
112
113* Autres sujets
114 * [Utiliser Eclipse avec QMK](fr-fr/other_eclipse.md)
115 * [Utiliser VSCode avec QMK](fr-fr/other_vscode.md)
116 * [Support](fr-fr/getting_started_getting_help.md)
117 * [Comment ajouter des traductions](fr-fr/translating.md)
118
119* À l’intérieur de QMK (En cours de documentation)
120 * [Définitions](fr-fr/internals_defines.md)
121 * [Input Callback Reg](fr-fr/internals_input_callback_reg.md)
122 * [Appareils Midi](fr-fr/internals_midi_device.md)
123 * [Installation d’un appareil Midi](fr-fr/internals_midi_device_setup_process.md)
124 * [Utilitaires Midi](fr-fr/internals_midi_util.md)
125 * [Fonctions Midi](fr-fr/internals_send_functions.md)
126 * [Outils Sysex](fr-fr/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 4c3817d2e..000000000
--- a/docs/fr-fr/breaking_changes.md
+++ /dev/null
@@ -1,106 +0,0 @@
1# Breaking changes
2
3Ce 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.
4
5La 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.
6
7## Qu'est-ce qui a été inclus dans des Breaking Changes précédents?
8
9* [30 août 2019](ChangeLog/20190830.md)
10
11## Quand va être le prochain Breaking Change?
12
13Le prochain Breaking Change est planifié pour le 29 novembre.
14
15### Dates importantes
16
17* [x] 21 septembre 2019 - `future` est créé. Il va être rebasé de manière hebdomadaire.
18* [ ] 01 novembre 2019 - `future` fermé aux nouveaux PRs.
19* [ ] 01 novembre 2019 - Appel aux testeurs.
20* [ ] 27 novembre 2019 - `master` est bloqué, pas de PRs fusionnés.
21* [ ] 29 novembre 2019 - `future` est fusionné dans `master`.
22* [ ] 30 novembre 2019 - `master` est débloqué. Les PRs peuvent à nouveau être fusionnés.
23
24## Quels changements seront inclus?
25
26Pour 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é.
27
28Si 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é.
29
30Critère d'acceptation:
31
32* Le PR est complété et prêt à fusionner
33* Le PR a un ChangeLog
34
35# Checklists
36
37Cette section documente plusieurs processus que nous utilisons en lançant le processus de Breaking Change.
38
39## Rebase `future` de `master`
40
41Ceci est lancé chaque vendredi tant que `future` est ouvert.
42
43Processus:
44
45```
46cd qmk_firmware
47git checkout master
48git pull --ff-only
49git checkout future
50git rebase master
51git push --force
52```
53
54## Créer la branche `future`
55
56Ceci est fait immédiatement après la fusion de la branche `future` précédente.
57
58* `qmk_firmware` git commands
59 * [ ] `git checkout master`
60 * [ ] `git pull --ff-only`
61 * [ ] `git checkout -b future`
62 * [ ] Modifie `readme.md`
63 * [ ] Ajoute un message en haut qui indique que c'est une branche de test.
64 * [ ] Ajoute un lien vers ce document
65 * [ ] `git commit -m 'Branch point for <DATE> Breaking Change'`
66 * [ ] `git tag breakpoint_<YYYY>_<MM>_<DD>`
67 * [ ] `git tag <next_version>` # Evite que le label point d'arrêt soit confondu par un incrément de version
68 * [ ] `git push origin future`
69 * [ ] `git push --tags`
70
71## 4 Semaines Avant la Fusion
72
73* `future` est maintenant fermé aux nouveaux PRs, seul des correctifs pour les PRs courants peuvent être mergés
74* Envoi de l'appel aux testeurs
75 * [ ] Discord
76 * [ ] GitHub PR
77 * [ ] https://reddit.com/r/olkb
78
79## 1 Semaine Avant la Fusion
80
81* Annonce que master sera fermée entre <2 jours avant> à <Jour de la fusion>
82 * [ ] Discord
83 * [ ] GitHub PR
84 * [ ] https://reddit.com/r/olkb
85
86## 2 Jours Avant la Fusion
87
88* Annonce que master est fermé pour 2 jours
89 * [ ] Discord
90 * [ ] GitHub PR
91 * [ ] https://reddit.com/r/olkb
92
93## Jour de la fusion
94
95* `qmk_firmware` git commands
96 * [ ] `git checkout future`
97 * [ ] `git pull --ff-only`
98 * [ ] `git rebase origin/master`
99 * [ ] Modifie `readme.md`
100 * [ ] Supprimer les notes à propos de `future`
101 * [ ] Regroupe ChangeLog dans un fichier.
102 * [ ] `git commit -m 'Merge point for <DATE> Breaking Change'`
103 * [ ] `git push origin future`
104* Actions sur GitHub
105 * [ ] Crée un PR pour `future`
106 * [ ] Fusion le PR `future`
diff --git a/docs/fr-fr/cli.md b/docs/fr-fr/cli.md
deleted file mode 100644
index 917a9315b..000000000
--- a/docs/fr-fr/cli.md
+++ /dev/null
@@ -1,127 +0,0 @@
1# La CLI de QMK
2
3Cette page décrit comment configurer et utiliser la CLI QMK.
4
5# Vue d'ensemble
6
7La 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.
8
9* [CLI globale](#global-cli)
10* [CLI locale](#local-cli)
11* [Les commandes CLI](#cli-commands)
12
13# Pré-requis
14
15La 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).
16
17# CLI globale
18
19QMK 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.
20
21## Installer en utilisant Homebrew (macOS, quelques Linux)
22
23Si vous avez installé [Homebrew](https://brew.sh) vous pouvez entrer ce qui suit et installer QMK:
24
25```
26brew tap qmk/qmk
27brew install qmk
28export QMK_HOME='~/qmk_firmware' # Optional, set the location for `qmk_firmware`
29qmk setup # This will clone `qmk/qmk_firmware` and optionally set up your build environment
30```
31
32## Installer en utilisant easy_install ou pip
33
34Si 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:
35
36```
37pip3 install qmk
38export QMK_HOME='~/qmk_firmware' # Optional, set the location for `qmk_firmware`
39qmk setup # This will clone `qmk/qmk_firmware` and optionally set up your build environment
40```
41
42## Paquets pour d'autres systèmes d'exploitation
43
44Nous 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:
45
46* Suivez les bonnes pratiques pour votre système d'exploitation lorsqu'elles entrent en conflit avec ces directives
47 * Documentez pourquoi dans un commentaire lorsque vous ne les suivez pas
48* Installez en utilisant un virtualenv
49* 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`.
50
51# Les commandes CLI
52
53## `qmk compile`
54
55Cette 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.
56
57**Utilisation pour les exports de configuration**:
58
59```
60qmk compile <configuratorExport.json>
61```
62
63**Utilisation pour les Keymaps**:
64
65```
66qmk compile -kb <keyboard_name> -km <keymap_name>
67```
68
69## `qmk format-c`
70
71Cette 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.
72
73**Utilisation**:
74
75```
76qmk format-c [file1] [file2] [...] [fileN]
77```
78
79## `qmk config`
80
81Cette commande vous permet de configurer le comportement de QMK. Pour la documentation complète de `qmk config`, regardez [Configuration de CLI](cli_configuration.md).
82
83**Utilisation**:
84
85```
86qmk config [-ro] [config_token1] [config_token2] [...] [config_tokenN]
87```
88
89## `qmk doctor`
90
91Cette commande examine votre environnement et vous alertes des potentiels problèmes de compilation ou de flash.
92
93**Utilisation**:
94
95```
96qmk doctor
97```
98
99## `qmk new-keymap`
100
101Cette commande crée une nouvelle keymap basée sur une keymap par défaut d'un clavier existant.
102
103**Utilisation**:
104
105```
106qmk new-keymap [-kb KEYBOARD] [-km KEYMAP]
107```
108
109## `qmk format-py`
110
111Cette commande formate le code python dans `qmk_firmware`.
112
113**Utilisation**:
114
115```
116qmk format-py
117```
118
119## `qmk pytest`
120
121Cette 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.
122
123**Utilisation**:
124
125```
126qmk pytest
127```
diff --git a/docs/fr-fr/cli_configuration.md b/docs/fr-fr/cli_configuration.md
deleted file mode 100644
index 3eed1e0e9..000000000
--- a/docs/fr-fr/cli_configuration.md
+++ /dev/null
@@ -1,121 +0,0 @@
1# Configuration de QMK CLI
2
3Ce document explique comment fonctionne la commande `qmk config`.
4
5# Introduction
6
7La 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.
8
9## Exemple simple
10
11Comme exemple, regardons la commande `qmk compile --keyboard clueboard/66/rev4 --keymap default`.
12
13Il y a deux arguments de ligne de commande qui peuvent être lu de la configuration:
14
15* `compile.keyboard`
16* `compile.keymap`
17
18Essayons de les définir:
19
20```shell
21$ qmk config compile.keyboard=clueboard/66/rev4 compile.keymap=default
22compile.keyboard: None -> clueboard/66/rev4
23compile.keymap: None -> default
24Ψ Wrote configuration to '/Users/example/Library/Application Support/qmk/qmk.ini'
25```
26
27Maintenant, je peux lancer la commande `qmk compile` sans avoir à spécifier mon clavier et keymap à chaque fois.
28
29## Définir les options par défaut
30
31Parfois, 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.
32
33Exemple:
34
35```
36$ qmk config user.keyboard=clueboard/66/rev4 user.keymap=default
37user.keyboard: None -> clueboard/66/rev4
38user.keymap: None -> default
39Ψ Wrote configuration to '/Users/example/Library/Application Support/qmk/qmk.ini'
40```
41
42# CLI Documentation (`qmk config`)
43
44La 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:
45
46 <subcommand|general|default>[.<key>][=<value>]
47
48## Définir des valeurs de configuration
49
50Vous 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>`.
51
52Exemple:
53
54```
55$ qmk config default.keymap=default
56default.keymap: None -> default
57Ψ Wrote configuration to '/Users/example/Library/Application Support/qmk/qmk.ini'
58```
59
60## Lire des valeurs de configuration
61
62Vous 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.
63
64### Exemple avec la totalité de la configuration
65
66 qmk config
67
68### Exemple avec une section entière
69
70 qmk config compile
71
72### Exemple avec une clé unique
73
74 qmk config compile.keyboard
75
76### Exemple avec plusieurs clés
77
78 qmk config user compile.keyboard compile.keymap
79
80## Supprimer des valeurs de configuration
81
82Vous pouvez supprimer une valeur de configuration en la définissant avec la chaîne spéciale `None`.
83
84Exemple:
85
86```
87$ qmk config default.keymap=None
88default.keymap: default -> None
89Ψ Wrote configuration to '/Users/example/Library/Application Support/qmk/qmk.ini'
90```
91
92## Plusieurs opérations
93
94Vous 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:
95
96```
97$ qmk config compile default.keymap=default compile.keymap=None
98compile.keymap=skully
99compile.keyboard=clueboard/66_hotswap/gen1
100default.keymap: None -> default
101compile.keymap: skully -> None
102Ψ Wrote configuration to '/Users/example/Library/Application Support/qmk/qmk.ini'
103```
104
105# Options de configuration utilisateur
106
107| Clé | Valeur par défaut | Description |
108|-----|---------------|-------------|
109| user.keyboard | None | Le chemin d'accès vers le clavier (Exemple: `clueboard/66/rev4`) |
110| user.keymap | None | Le nom de la keymap (Exemple: `default`) |
111| user.name | None | Le nom d'utilisateur GitHub de l'utilisateur. |
112
113# Toutes les options de configuration
114
115| Clé | Valeur par défaut | Description |
116|-----|---------------|-------------|
117| compile.keyboard | None | Le chemin d'accès vers le clavier (Exemple: `clueboard/66/rev4`) |
118| compile.keymap | None | Le nom de la keymap (Exemple: `default`) |
119| hello.name | None | Le nom à saluer lorsque démarré. |
120| new_keyboard.keyboard | None | Le chemin d'accès vers le clavier (Exemple: `clueboard/66/rev4`) |
121| 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 d13587105..000000000
--- a/docs/fr-fr/contributing.md
+++ /dev/null
@@ -1,154 +0,0 @@
1# Comment contribuer
2
3👍🎉 Premièrement, merci de prendre le temps de lire ceci et de contribuer! 🎉👍
4
5Les 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.
6
7* [Aperçu du projet](#project-overview)
8* [Conventions de codage](#coding-conventions)
9* [Directives générales](#general-guidelines)
10* [Que veut dire le code de conduite pour moi?](#what-does-the-code-of-conduct-mean-for-me)
11
12## Je ne veux pas lire tout ce pavé! J'ai juste une question!
13
14Si 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).
15
16Merci de garder ceci en tête:
17
18* Cela peut prendre plusieurs heures pour que quelqu'un réponde à votre question. Merci d'être patient!
19* 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.
20* 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):
21 * https://opensource.com/life/16/10/how-ask-technical-questions
22 * http://www.catb.org/esr/faqs/smart-questions.html
23
24# Aperçu du projet
25
26QMK 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](https://www.fourwalledcubicle.com/LUFA.php)) et ARM ([ChibiOS](https://www.chibios.org)). 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.
27
28<!-- FIXME: We should include a list of resources for learning C here. -->
29
30# Où trouver de l'aide?
31
32Si 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).
33
34# Comment contribuer?
35
36Vous n'avez encore jamais contribué à un projet open source? Vous vous demandez comment les contributions dans QMK fonctionnent? Voici un aperçu rapide!
37
380. Enregistrez-vous sur [GitHub](https://github.com).
391. 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.
402. 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`.
413. Clonez le dépôt sur votre machine locale en utilisant `git clone https://github.com/login-github/repository-name.git`.
424. Si vous travaillez sur une nouvelle fonctionnalité, pensez à ouvrir une issue pour parler avec nous du travail que vous souhaitez démarrer.
435. Créez une nouvelle branche pour votre correctif en utilisant `git checkout -b nom-de-branche`.
446. Faites les changements nécessaires pour corriger le problème ou ajouter la fonctionnalité.
457. 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.
468. Utilisez `git commit -m "Insérez une description courte des changements (en anglais)"` pour enregistrer le contenu de l'index avec un message descriptif.
479. Poussez les changements vers votre dépôt sur GitHub en utilisant `git push origin nom-de-branche`.
4810. Créez un pull request sur [QMK Firmware](https://github.com/qmk/qmk_firmware/pull/new/master).
4911. 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".
5012. 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!
5113. Attendez que le pull request soit revu par un mainteneur.
5214. Faites des changements au pull request si le mainteneur le recommande.
5315. Célébrez votre succès une fois votre pull request fusionné!
54
55# Conventions de codage
56
57La 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.
58
59* [Conventions de codage - C](coding_conventions_c.md)
60* [Conventions de codage - Python](coding_conventions_python.md)
61
62# Directives générales
63
64Nous 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.
65
66* 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é.
67* Vérifiez les espaces blancs non nécessaires avec `git diff --check` avant de commit.
68* Assurez-vous que votre code compile.
69 * Keymaps: Assurez-vous que `make keyboard:your_new_keymap` ne renvoie pas d'erreur.
70 * Claviers: Assurez-vous que `make keyboard:all` ne renvoie pas d'erreur.
71 * Core: Assurez-vous que `make all` ne renvoie pas d'erreur.
72* 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:
73
74```
75Adjust the fronzlebop for the kerpleplork
76
77The kerpleplork was intermittently failing with error code 23. The root cause was the fronzlebop setting, which causes the kerpleplork to activate every N iterations.
78
79Limited 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.
80```
81
82## Documentation
83
84La 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)!
85
86Vous 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 https://docs.qmk.fm/.
87
88Lorsque 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:
89
90```c
91enum my_layers {
92 _FIRST_LAYER,
93 _SECOND_LAYER
94};
95
96enum my_keycodes {
97 FIRST_LAYER = SAFE_RANGE,
98 SECOND_LAYER
99};
100```
101
102## Keymaps
103
104La 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.
105
106* Ecrivez un fichier `readme.md` en utilisant [la template](documentation_templates.md).
107* 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.
108* 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.
109* N'incluez pas de fichier `Makefile` dans votre dossier de keymap (ils ne sont plus utilisés)
110* Mettez à jour les copyrights dans les en-têtes de fichiers (cherchez `%YOUR_NAME%`)
111
112## Claviers
113
114Les 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.
115
116Nous vous demandons aussi que vous suiviez ces directives:
117
118* Ecrivez un fichier `readme.md` en utilisant [le template](documentation_templates.md).
119* Gardez un nombre de commits raisonnable, ou nous squasherons votre PR.
120* 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.
121* Appelez les fichiers `.c`/`.h` du nom du dossier parent, par exemple `/keyboards/<kb1>/<kb2>/<kb2>.[ch]`
122* N'incluez pas de fichier `Makefile` dans votre dossier de keymap (ils ne sont plus utilisés)
123* Mettez à jour les copyrights dans les en-têtes de fichiers (cherchez `%YOUR_NAME%`)
124
125## Quantum/TMK Core
126
127Faites 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:
128
129* [Chat sur Discord](https://discord.gg/Uq7gcHh)
130* [Ouvrir une Issue](https://github.com/qmk/qmk_firmware/issues/new)
131
132Les 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é.
133
134Voici quelques choses à garder en tête lorsque vous travaillez sur une fonctionnalité ou un bug fix.
135
136* **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.
137* **Compilez localement avant de soumettre** - Cela devrait aller sans dire, mais votre code doit compiler! Vous devriez toujours faire gaffe à ce que vos changements compilent avant d'ouvrir une pull request.
138* **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.
139* **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.
140
141Nous vous demandons aussi de suivre ces directives:
142
143* Gardez un nombre de commits raisonnable, ou nous squasherons votre PR.
144* Ne regroupez pas des claviers ou des keymaps avec des changements core. Soumettez vos changements core en premier.
145* Ecrivez des [Tests Unitaires](unit_testing.md) pour votre fonctionnalité.
146* 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.
147
148## Refactoriser
149
150Afin 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.
151
152# Que veut dire le code de conduite pour moi?
153
154Note [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/driver_installation_zadig.md b/docs/fr-fr/driver_installation_zadig.md
deleted file mode 100644
index 35beefa3c..000000000
--- a/docs/fr-fr/driver_installation_zadig.md
+++ /dev/null
@@ -1,46 +0,0 @@
1# Installation du driver du bootloader avec Zadig
2
3Vous n’aurez pas besoin de pilote particulier pour utiliser un clavier QMK. En effet, QMK se présente à l'ordinateur hôte comme un clavier HID standard et sera reconnu sans problème. Cependant vous aurez peut-être besoin d'un pilote pour flasher votre clavier avec Windows. En effet, quand vous redémarrerez votre clavier en mode bootloader, le périphérique que détectera Windows ne sera pas un clavier mais un périphérique bootloader.
4
5Il existe deux exceptions : le bootloader Caterina, qui se trouve en général sur les Pro Micros, et le bootloader Halfkay, livré avec les Teensy de PJRC. Ils apparaissent respectivement sous la forme d'un port série et d'un périphérique HID générique, ne nécessitant pas de pilote particulier.
6
7Nous vous recommandons d'utiliser l'utilitaire [Zadig](https://zadig.akeo.ie/). Si vous avez configuré votre environnement de développement avec Msys2 ou WSL, le script `qmk_install.sh` vous aura proposé l'installation des pilotes durant le processus.
8
9## Installation
10
11Passez votre clavier en mode bootloader, soit en appuyant sur le keycode `RESET` (qui peut se trouver dans un calque différent) ou en appuyant sur le bouton reset qui se trouve en général sous la board. Si votre clavier n'a aucune de ces options, essayez de le brancher en maintenant Escape ou Espace+`B` appuyés (voir la documentation de [Bootmagic](feature_bootmagic.md) pour plus de détails). Certaines boards utilisent [Command](feature_command.md) à la place de Bootmagic. Dans ce cas, vous pouvez entrer en mode bootloader en appuyant, à n'importe quel moment lorsque le clavier est branché, sur les combinaisons de touches Shift Gauche+Shift Droit+`B` ou Shift Gauche+Shift Droit+Escape.
12Certains claviers ont des instructions spécifiques pour passer en mode bootloader. Par exemple, la touche [Bootmagic Lite]](feature_bootmagic.md#bootmagic-lite) (défaut: Échap) peut être sur une touche différente telle que Contrôle Gauche. La combinaison pour la Command (défaut: Shift Gauche+Shift Droit) peut être différente, par exemple Contrôle Gauche+Contrôle Droit. Référez-vous au fichier README de votre clavier.
13
14Pour mettre un clavier en mode bootloader avec USBaspLoader, appuyez sur le bouton `RESET` tout en maintenant le bouton `BOOT`. Vous pouvez aussi maintenir le bouton `BOOT` en branchant le câble USB.
15
16Zadig détectera automatiquement les périphériques en mode bootloader. Il se peut toutefois que vous deviez vérifier en passant par **Options → List All Devices**.
17
18
19 - Pour les claviers avec des MCUs Atmel AVR, le bootloader aura un nom similaire à `ATm32U4DFU`, et un Vendor ID `03EB`.
20 - Les bootloaders USBasp s'appelleront `USBasp`, avec un VID/PID `16C0:05DC`.
21 - Les claviers AVR flashé avec le bootloader QMK-DFU s'appelleront `<nom du clavier> Bootloader` et auront aussi le VID `03EB`.
22 - Pour la plupart des claviers ARM, ils s'appelleront `STM32 BOOTLOADER`, et auront un VID/PID `0483:DF11`.
23
24!> Si Zadig affiche certains de vos périphériques avec le driver `HidUsb`, votre clavier n'est probablement pas en mode bootloader. La flèche aura une couleur orange et vous aurez un message de confirmation vous demandant de modifier un pilote système. **Ne continuez pas!**
25
26Si la flèche apparaît en vert, sélectionnez le driver et appuyez sur le bouton **Install Driver**. Le driver `libusb-win32` devrait normalement fonctionner pour AVR, et `WinUSB` pour ARM. Si vous avez des problèmes pour flasher la board, essayez d'installer un pilote différent de la liste. Pour flasher un périphérique USBaspLoader en ligne de commande avec msys2, le driver `libusbk` est recommandé, sinon `libusb-win32` devrait fonctionner correctement si vous utilisez QMK Toolbox pour flasher.
27
28![Zadig montrant un driver de bootloader installé correctement](https://i.imgur.com/b8VgXzx.png)
29
30Finalement, débranchez et rebranchez le clavier afin de vous assurer que le nouveau pilote a bien été chargé. Si vous utilisez QMK Toolbox pour flasher, redémarrez-le aussi, il arrive qu'il n'arrive pas à détecter le changement de driver.
31
32## Récupérer l'installation du mauvais périphérique
33
34Si vous n'arrivez plus à saisir de texte avec le clavier, il est possible que vous ayez installé le driver sur le clavier au lieu du bootloader. Vous pouvez facilement vérifier ceci dans Zadig. Un clavier fonctionnel a le pilote `HidUsb` installé sur toutes ses interfaces :
35
36![Un clavier fonctionnel vu par Zadig](https://i.imgur.com/Hx0E5kC.png)
37
38Ouvrez le Gestionnaire de périphériques et cherchez un périphérique qui ressemble à votre clavier.
39
40![La board avec le mauvais driver installé, dans le Gestionnaire de périphériques](https://i.imgur.com/L3wvX8f.png)
41
42Cliquez dessus avec le bouton droit et sélectionner **Désinstaller le périphérique**. Faites bien attention à sélectionner **Supprimer le pilote pour ce périphérique** avant de valider.
43
44![Le dialogue Suppression de périphérique, avec la boîte "suppression de pilote" cochée](https://i.imgur.com/aEs2RuA.png)
45
46Appuyez sur **Action → Analyser les changements de hardware**. A ce stade, vous devriez pouvoir saisir à nouveau. Vérifiez dans Zadig que les périphériques utilisent bien le pilote `HidUsb`. Si c'est le cas, vous avez corrigé le problème, votre clavier devrait fonctionner à nouveau!
diff --git a/docs/fr-fr/faq.md b/docs/fr-fr/faq.md
deleted file mode 100644
index 89576b3cc..000000000
--- a/docs/fr-fr/faq.md
+++ /dev/null
@@ -1,6 +0,0 @@
1# Foire Aux Questions
2
3* [FAQ Générale](faq_general.md)
4* [Construire ou Compiler QMK](faq_build.md)
5* [Débuguer et Dépanner QMK](faq_debug.md)
6* [Keymap (disposition)](faq_keymap.md)
diff --git a/docs/fr-fr/faq_build.md b/docs/fr-fr/faq_build.md
deleted file mode 100644
index c6a325353..000000000
--- a/docs/fr-fr/faq_build.md
+++ /dev/null
@@ -1,154 +0,0 @@
1# Foire aux questions sur la compilation
2
3Cette page couvre les questions concernant la compilation de QMK. Si vous ne l'avez pas encore fait, vous devriez lire les guides [Configuration de l'environnement de build](getting_started_build_tools.md) et [Instructions pour Make](getting_started_make_guide.md).
4
5## Je ne peux pas programmer sous Linux
6
7Vous aurez besoin des permissions appropriées pour utiliser un périphérique. Pour les utilisateurs de Linux, référez-vous aux instructions concernant les règles `udev` ci-dessous. Si `udev` vous pose des problèmes, une alternative est d'utiliser la commande `sudo`. Si vous ne connaissez pas cette commande, référez-vous à son manuel d'utilisation en utilisant `man sudo` ou [regardez cette page](https://linux.die.net/man/8/sudo).
8
9Un exemple utilisant `sudo`, lorsque votre contrôleur est un ATMega32u4 :
10
11 $ sudo dfu-programmer atmega32u4 erase --force
12 $ sudo dfu-programmer atmega32u4 flash your.hex
13 $ sudo dfu-programmer atmega32u4 reset
14
15ou simplement :
16
17 $ sudo make <keyboard>:<keymap>:dfu
18
19Veuillez noter que lancer `make` avec `sudo` est généralement une **mauvaise** idée, et vous devriez préférer une des méthodes précédente, si possible.
20
21### Règles `udev` pour Linux
22
23Sous Linux, vous aurez besoin des permissions appropriées pour accéder au MCU (le micro-contrôleur). Vous avez le choix d'utiliser `sudo` en flashant le firmware, ou placer ces fichiers dans `/etc/udev/rules.d`. Une fois ajouté, lancez les commandes suivantes:
24
25```console
26sudo udevadm control --reload-rules
27sudo udevadm trigger
28```
29
30**/etc/udev/rules.d/50-atmel-dfu.rules:**
31```
32# Atmel ATMega32U4
33SUBSYSTEMS=="usb", ATTRS{idVendor}=="03eb", ATTRS{idProduct}=="2ff4", MODE:="0666"
34# Atmel USBKEY AT90USB1287
35SUBSYSTEMS=="usb", ATTRS{idVendor}=="03eb", ATTRS{idProduct}=="2ffb", MODE:="0666"
36# Atmel ATMega32U2
37SUBSYSTEMS=="usb", ATTRS{idVendor}=="03eb", ATTRS{idProduct}=="2ff0", MODE:="0666"
38```
39
40**/etc/udev/rules.d/52-tmk-keyboard.rules:**
41```
42# tmk keyboard products https://github.com/tmk/tmk_keyboard
43SUBSYSTEMS=="usb", ATTRS{idVendor}=="feed", MODE:="0666"
44```
45
46**/etc/udev/rules.d/54-input-club-keyboard.rules:**
47
48```
49# Input Club keyboard bootloader
50SUBSYSTEMS=="usb", ATTRS{idVendor}=="1c11", MODE:="0666"
51```
52
53**/etc/udev/rules.d/55-catalina.rules:**
54```
55# ModemManager should ignore the following devices
56ATTRS{idVendor}=="2a03", ENV{ID_MM_DEVICE_IGNORE}="1"
57ATTRS{idVendor}=="2341", ENV{ID_MM_DEVICE_IGNORE}="1"
58```
59
60**Note:** Le filtrage utilisant ModemManager fonctionnera uniquement si vous n'êtes pas en mode strict. Les commandes suivantes peuvent changer cette option :
61
62```console
63sudo sed -i 's/--filter-policy=strict/--filter-policy=default/' /lib/systemd/system/ModemManager.service
64sudo systemctl daemon-reload
65sudo systemctl restart ModemManager
66```
67
68**/etc/udev/rules.d/56-dfu-util.rules:**
69
70```
71# stm32duino
72SUBSYSTEMS=="usb", ATTRS{idVendor}=="1eaf", ATTRS{idProduct}=="0003", MODE:="0666"
73# Generic stm32
74SUBSYSTEMS=="usb", ATTRS{idVendor}=="0483", ATTRS{idProduct}=="df11", MODE:="0666"
75```
76
77### Le périphérique sériel n'est pas détecté en mode bootloader sous Linux
78
79Assurez-vous que votre kernel ait un support approprié pour votre périphérique. Si votre périphérique utilise USB ACM, par exemple pour les Pro Micro (AtMega32u4), assurez-vous d'inclure `CONFIG_USB_ACM=y`. D'autres périphériques peuvent avoir besoin de `USB_SERIAL` et de ses sous-options.
80
81## Périphérique inconnu pour le bootloader DFU
82
83Les problèmes rencontrés lorsque l'on flash des claviers sous Windows sont, la plupart du temps, dus à une installation du mauvais pilote, ou un pilote manquant.
84
85Relancer le script d'installation de QMK (`./util/qmk_install.sh` situé dans répertoire `qmk_firmware`sous MSYS2 ou WSL) ou réinstaller la QMK Toolbox peut résoudre le problème. Une alternative est de télécharger et lancer manuellement le package [`qmk_driver_installer`](https://github.com/qmk/qmk_driver_installer).
86
87Si vous rencontrez toujours des problèmes, essayez de télécharger et lancer Zadig. Voir [Installation du driver du bootloader avec Zadig](driver_installation_zadig.md) pour plus d'informations.
88
89## USB VID et PID
90
91Vous pouvez utiliser l'ID de votre choix en modifier `config.h`. Il y a peu de chance de conflit avec d'autres produits.
92
93La plupart des boards QMK utilisent `0xFEED` comme vendor ID. Vérifiez les autres claviers pour être sûr de choisir un Product ID unique.
94
95Étudiez aussi ce ticket
96https://github.com/tmk/tmk_keyboard/issues/150
97
98Vous pouvez acheter un VID:PID unique ici. Je ne pense pas que ce soit nécessaire pour un usage personnel.
99- https://www.obdev.at/products/vusb/license.html
100- https://www.mcselec.com/index.php?page=shop.product_details&flypage=shop.flypage&product_id=92&option=com_phpshop&Itemid=1
101
102## BOOTLOADER_SIZE pour AVR
103
104Notez que la taille du bootloader pour les Teensy2.0++ est de 2048bytes. Quelques Makefiles peuvent contenir une erreur et avoir le mauvais commentaire.
105
106```
107# Boot Section Size in *bytes*
108# Teensy halfKay 512
109# Teensy++ halfKay 2048
110# Atmel DFU loader 4096 (TMK Alt Controller)
111# LUFA bootloader 4096
112# USBaspLoader 2048
113OPT_DEFS += -DBOOTLOADER_SIZE=2048
114```
115
116## `avr-gcc: internal compiler error: Abort trap: 6 (program cc1)` sous MacOS
117
118C'est un problème de mise à jour avec brew, causée par des liens symboliques (symlinks) dont dépend avr-gcc qui sont détruits.
119
120La solution est de supprimer et réinstaller tous les modules affectés.
121
122```
123brew rm avr-gcc
124brew rm dfu-programmer
125brew rm dfu-util
126brew rm gcc-arm-none-eabi
127brew rm avrdude
128brew install avr-gcc
129brew install dfu-programmer
130brew install dfu-util
131brew install gcc-arm-none-eabi
132brew install avrdude
133```
134
135### avr-gcc 8.1 et LUFA
136
137Si vous avez mis à jour votre avr-gcc au-dessus de la version 7, vous risquez de voir des erreurs impliquant LUA. Par exemple :
138
139`lib/lufa/LUFA/Drivers/USB/Class/Device/AudioClassDevice.h:380:5: error: 'const' attribute on function returning 'void'`
140
141Pour le moment, vous devrez revenir à la version 7 de avr-gcc dans brew.
142
143```
144brew uninstall --force avr-gcc
145brew install avr-gcc@8
146brew link --force avr-gcc@8
147```
148
149### Je viens de flasher mon clavier et il ne fait rien/l'appui des touches n'est pas enregistré - c'est aussi un ARM(rev6 plank, clueboard 60, hs60v2, etc.) (Février 2019)
150
151A cause de la manière dont les EEPROM fonctionnent sur les puces ARM, les options sauvegardées peuvent ne plus être valides. Ceci affecte les calques par défaut et *peut*, sous certaines conditions que nous essayons encore de déterminer, rendre le clavier inutilisable. Réinitialiser l'EEPROM corrigera le problème.
152
153[Réinitialiser EEPROM sur Planck rev6](https://cdn.discordapp.com/attachments/473506116718952450/539284620861243409/planck_rev6_default.bin) peut être utilisé pour forcer une réinitialisation d'EEPROM. Une fois cette image flashée, flashez à nouveau votre firmware standard. Cela devrait rétablir le fonctionnement de votre clavier.
154Si bootmagic est activé dans n'importe quel forme, vous devriez être capable de faire aussi ceci (regardez [Documentation Bootmagic](feature_bootmagic.md) et les informations spécifiques à votre clavier).
diff --git a/docs/fr-fr/faq_debug.md b/docs/fr-fr/faq_debug.md
deleted file mode 100644
index 8868744f7..000000000
--- a/docs/fr-fr/faq_debug.md
+++ /dev/null
@@ -1,153 +0,0 @@
1# FAQ Débugage
2
3Cette page détaille diverses questions fréquemment posées par les utilisateurs sur le dépannage de leurs claviers.
4
5# Console de débugage
6
7## `hid_listen` ne reconnaît pas de périphérique
8
9Lorsque la console de débugage sur votre périphérique n'est pas prêt, vous obtiendrez un message similaire:
10
11```
12Waiting for device:.........
13```
14
15Une fois le périphérique connecté, *hid_listen* le trouve et vous obtiendrez ce message:
16
17```
18Waiting for new device:.........................
19Listening:
20```
21
22Si vous ne recevez pas ce message `Listening:`, essayez de compiler avec `CONSOLE_ENABLE=yes` dans le [Makefile]
23
24Il se peut que vous ayez besoin de certains privilèges avancés pour accéder à des périphériques sur des OS comme Linux.
25
26- Essayez `sudo hid_listen`
27
28## Ne reçoit pas de messages sur la console
29
30Vérifiez :
31
32- *hid_listen* trouve votre périphérique. Voir ci-dessus.
33- Activez le débugage en appuyant sur **Magic**+d. Voir [Commandes Magic](https://github.com/tmk/tmk_keyboard#magic-commands).
34- Définissez `debug_enable=true` en général dans `matrix_init()` du fichier **matrix.c**.
35- Essayez d'utiliser la fonction `print` à la place du debug print. Voir **common/print.h**.
36- Déconnectez tous les autres périphériques qui utilisent la fonction console. Voir [Issue #97](https://github.com/tmk/tmk_keyboard/issues/97).
37
38## Linux ou les systèmes UNIX nécessitent des privilèges super utilisateur
39
40Utilisez `sudo` pour exécuter *hid_listen* avec des privilèges étendus.
41
42```
43$ sudo hid_listen
44```
45
46Ou ajoutez une *udev rule* pour les périphériques TMK en plaçant un fichier dans le répertoire rules. Le chemin vers ce répertoire peut varier en fonction du système.
47
48Fichier: /etc/udev/rules.d/52-tmk-keyboard.rules(sous Ubuntu)
49```
50# tmk keyboard products https://github.com/tmk/tmk_keyboard
51SUBSYSTEMS=="usb", ATTRS{idVendor}=="feed", MODE:="0666"
52```
53
54***
55
56# Divers
57
58## Considérations de sécurité
59
60Vous ne voulez probablement pas "briquer" votre clavier, rendre impossible d'écrire un firmware dessus. Il y a quelques paramètres qui montrent ce qui est (et n'est probablement pas) trop risqué.
61
62- Si votre map de clavier n'inclut pas de RESET, pour entrer en mode DFU, vous devrez appuyer sur le bouton reset du PCB. Cela implique que vous devrez certainement dévisser certaines pièces de votre clavier pour y accéder.
63- Modifier les fichiers tmk_core / common peut rendre le clavier inutilisable
64- Si un fichier .hex trop large est la cause du problème: `make dfu` supprime le bloc puis teste la taille (il ne fait pas les choses dans le bon ordre), ce qui provoque une erreur. En résultat, le flash n’aura pas été fait et le clavier restera en mode DFU.
65- Pour finir, notez que la taille maximale d'un fichier .hex sur un Plank est de 7000h (28672 decimal)
66
67```
68Linking: .build/planck_rev4_cbbrowne.elf [OK]
69Creating load file for Flash: .build/planck_rev4_cbbrowne.hex [OK]
70
71Size after:
72 text data bss dec hex filename
73 0 22396 0 22396 577c planck_rev4_cbbrowne.hex
74```
75
76- La taille du fichier ci-dessus est de 22396/577ch, ce qui est en dessous de 28672/7000h
77- Tant que vous avez un fichier .hex alternatif correct, vous pouvez réessayer en le chargeant
78- Certaines options que vous pouvez spécifier dans votre Makefile consomme de la mémoire supplémentaire. Faites attention aux options BOOTMAGIC_ENABLE, MOUSEKEY_ENABLE, EXTRAKEY_ENABLE, CONSOLE_ENABLE, API_SYSEX_ENABLE.
79- Les outils DFU **ne** vous permettent **pas** d'écrire dans le bootloader (à moins que vous n'ajoutiez des options spéciales), il n'y a donc peu de risque.
80- Les EEPROM ont environ 100000 cycles d'écriture. Ne réécrivez pas le firmware de manière continue et répétée. Vous allez détruire définitivement l'EEPROM.
81
82## NKRO ne fonctionne pas
83
84Premièrement, vous devez compiler le firmware avec l'option de compilation `NKRO_ENABLE` dans le **Makefile**.
85
86Essayez la commande `Magic` **N** (`LShift+RShift+N` par défaut) si **NKRO** ne fonctionne toujours pas. Vous pouvez utiliser cette commande pour basculer temporairement entre le mode **NKRO** et **6KRO**. Sous certaines conditions, **NKRO** ne fonctionnera pas et vous devrez basculer en **6KRO**, en particulier lorsque vous êtes dans le BIOS.
87
88## Le TrackPoint a besoin Circuit de réinitialisation (Support de souris PS/2)
89
90Sans circuit de réinitialisation vous allez avoir des résultats inconsistants à cause de la mauvaise initialisation du matériel. Regardez le schéma du circuit du TPM754.
91
92- https://geekhack.org/index.php?topic=50176.msg1127447#msg1127447
93- https://www.mikrocontroller.net/attachment/52583/tpm754.pdf
94
95## Impossible de lire la colonne de la matrice après 16
96
97Utilisez `1UL<<16` à la place de `1<<16` dans `read_cols()` du fichier [matrix.h] lorsque le nombre de vos colonnes dépassent 16.
98
99En C, `1` implique un type [int] qui est [16 bits] pour les AVR, ce qui implique que vous ne pouvez pas décaler à gauche de plus de 15. Si vous utilisez `1<<16`, vous aurez un résultat non attendu de zéro. Vous devez donc utiliser un type [unsigned long] en utilisant `1UL`.
100
101https://deskthority.net/workshop-f7/rebuilding-and-redesigning-a-classic-thinkpad-keyboard-t6181-60.html#p146279
102
103## Les touches spéciales ne fonctionnent pas (Touche Système, Touches de contrôle du son)
104
105Vous devez définir `EXTRAKEY_ENABLE` dans le fichier `rules.mk` pour les utiliser dans QMK.
106
107```
108EXTRAKEY_ENABLE = yes # Audio control and System control
109```
110
111## Réveiller du mode veille ne fonctionne pas
112
113Sous Windows, activez l'option `Permettre au périphérique de sortir l'ordinateur de veille` dans les paramètres des **Options d'alimentations** du **Gestionnaire de périphériques**. Vérifiez aussi les paramètres du BIOS.
114
115Appuyer sur n'importe quelle touche en mode veille devrait sortir l'ordinateur de veille.
116
117## Vous utilisez un Arduino?
118
119**Faites attention au fait que le nommage des pin d'un Arduino diffère de la puce**. Par exemple, la pin `D0` n'est pas `PD0`. Vérifiez le circuit avec la fiche technique.
120
121- https://arduino.cc/en/uploads/Main/arduino-leonardo-schematic_3b.pdf
122- https://arduino.cc/en/uploads/Main/arduino-micro-schematic.pdf
123
124Les Arduino Leonardo et micro ont des **ATMega32U4** et peuvent être utilisés avec TMK, mais le bootloader Arduino peut causer des problèmes.
125
126## Activer JTAG
127
128Par défaut, le débugage des interfaces JTAG est désactivé dès que le clavier démarre. Les MCUs compatible JTAG viennent d'usine avec le fusible `JTAGEN` activé, et il prend certaines pins du MCU que la board pourrait utiliser pour la matrice, les LEDs, etc.
129
130Si vous voulez garder JTAG activé, ajoutez la ligne suivante à votre fichier `config.h` :
131
132```c
133#define NO_JTAG_DISABLE
134```
135
136## Compatibilité USB 3
137
138Il semble que certaines personnes ont eu des problèmes avec les ports USB 3, essayez un port USB 2.
139
140## Compatibilité Mac
141
142### OS X 10.11 et Hub
143
144https://geekhack.org/index.php?topic=14290.msg1884034#msg1884034
145
146## Problème sur BIOS (UEFI) / Resume (Mise en veille et réveil) / Redémarrage
147
148Certaines personnes ont eu des problèmes de fonctionnement de leur clavier dans le BIOS et/ou après des redémarrages.
149
150Pour le moment, l'origine du problème n'est pas comprise, mais certaines options de compilation semble liées. Dans le Makefile, essayez de désactiver les options comme `CONSOLE_ENABLE`, `NKRO_ENABLE`, `SLEEP_LED_ENABLE` et/ou d'autres.
151
152https://github.com/tmk/tmk_keyboard/issues/266
153https://geekhack.org/index.php?topic=41989.msg1967778#msg1967778
diff --git a/docs/fr-fr/faq_general.md b/docs/fr-fr/faq_general.md
deleted file mode 100644
index b1eae6df1..000000000
--- a/docs/fr-fr/faq_general.md
+++ /dev/null
@@ -1,16 +0,0 @@
1# Questions fréquemment posées
2
3## Qu'est-ce que QMK ?
4
5[QMK](https://github.com/qmk), acronyme pour Quantum Mechanical Keyboard, est un groupe de personnes qui construisent des outils pour des claviers personnalisés. Nous avons commencé par le [firmware QMK](https://github.com/qmk/qmk_firmware), un fork très modifié du firmware [TMK](https://github.com/tmk/tmk_keyboard).
6
7## Quelles sont les différences entre QMK et TMK ?
8
9TMK a été conçu et développé à l'origine par [Jun Wako](https://github.com/tmk). QMK a démarré comme étant le fork de [Jack Humbert](https://github.com/jackhumbert) pour le Planck. Au bout d'un moment, le fork de Jack a divergé de manière significative de TMK et, en 2015, Jack a décidé de le renommer QMK.
10
11D'un point de vue technique, QMK se base sur TMK en lui ajoutant plusieurs nouvelles fonctionnalités.
12QMK a notamment augmenté le nombre de keycodes disponibles et les a utilisé pour implémenter des fonctionnalités avancées telles que `S()`, `LCTL()` et `MO()`. Vous pouvez voir une liste complète de ces keycodes dans [Keycodes] (keycodes.md).
13
14D'un point de vue management de projet et communauté, Hasu, sur TMK maintient tous les claviers supportés officiellement par lui-même, avec un peu de support de la communauté. Il existe ou peuvent être créées d'autres communautés maintenant des fork pour d'autres claviers. Peu de keymaps sont définies par défaut, les utilisateurs ne se partagent donc pas leurs keymaps en général. QMK encourage le partage des claviers et des keymaps à l'aide d'un dépôt géré de manière centrale, acceptant les pull requests qui suivent les standards de qualité. Ceux-ci sont surtout maitenus par la communauté, mais l'équipe de QMK aide aussi lorsque c'est nécessaire.
15
16Les deux approches ont leurs avantages et leurs inconvénients, et le développements de fonctionnalités intéressantes sont partagées entre TMK et QMK lorsque fait sens.
diff --git a/docs/fr-fr/faq_keymap.md b/docs/fr-fr/faq_keymap.md
deleted file mode 100644
index cc0700ab8..000000000
--- a/docs/fr-fr/faq_keymap.md
+++ /dev/null
@@ -1,161 +0,0 @@
1# FAQ Keymap
2
3Cette page couvre les questions souvent posées à propos des keymaps. Si vous ne l'avez pas encore fait, vous devriez commencer par là [Aperçu des Keymap](keymap.md).
4
5## Quels Keycodes puis-je utiliser ?
6
7Regardez [Keycodes](keycodes.md) pour une liste des keycodes disponibles. Certains keycodes spécifiques ont des documentations plus complètes de disponible.
8
9Les keycodes sont définies dans [common/keycode.h](https://github.com/qmk/qmk_firmware/blob/master/quantum/keycode.h).
10
11## Quels sont les keycodes par défaut ?
12
13Il existe 3 configurations de clavier standard utilisées dans le monde: ANSI, ISO et JIS. L'Amérique du Nord utilise principalement l'ANSI, l'Europe et l'Afrique l'ISO et le Japon utilise JIS. Les autres régions utilisent généralement ANSI ou ISO. Les keycodes correspondant à ces dispositions spécifiques sont affichés ici :
14
15<!-- Source for this image: https://www.keyboard-layout-editor.com/#/gists/bf431647d1001cff5eff20ae55621e9a -->
16![Keyboard Layout Image](https://i.imgur.com/5wsh5wM.png)
17
18## Certaines de mes touches sont permutées ou ne fonctionnent pas
19
20QMK possède deux fonctionnalités, Bootmagic et Command, qui vous permettent de modifier le comportement de votre clavier à la volée. Cela inclut, sans toutefois s'y limiter, l'échange de Ctrl / Majuscules, la désactivation de l'interface graphique, le basculement de Alt/Gui, le basculement de barre d'espacement arrière/barre oblique inversée, la désactivation de toutes les touches et d'autres modifications comportementales.
21
22Pour résoudre rapidement le problème, essayez de maintenir les touches Espace + Retour arrière enfoncées pendant que vous branchez votre clavier. Cela réinitialisera les paramètres stockés sur votre clavier, ramenant ces touches à un fonctionnement normal. Si cela ne fonctionne pas, regardez ici:
23
24* [Bootmagic](feature_bootmagic.md)
25* [Command](feature_command.md)
26
27## La touche de menu ne fonctionne pas
28
29La touche trouvée sur la plupart des claviers modernes située entre `KC_RGUI` et` KC_RCTL` est en réalité appelée `KC_APP`. En effet, lorsque cette touche a été inventée, il existait déjà une clé nommée `MENU` dans les normes correspondantes. MS a donc choisi de l'appeler la touche` APP`.
30
31## `KC_SYSREQ` ne fonctionne pas
32
33Utilisez le keycode pour Print Screen (`KC_PSCREEN` or `KC_PSCR`) à la place de `KC_SYSREQ`. La combinaison de touche 'Alt + Print Screen' est reconnue comme 'System request'.
34
35Voir [issue #168](https://github.com/tmk/tmk_keyboard/issues/168) et
36* https://en.wikipedia.org/wiki/Magic_SysRq_key
37* https://en.wikipedia.org/wiki/System_request
38
39## Les touches alimentation ne fonctionnent pas
40
41Un peu déroutant, il y a deux codes de touche "Alimentation" dans QMK: `KC_POWER` dans la page d'utilisation du clavier / keypad, et `KC_SYSTEM_POWER` (ou `KC_PWR`) dans la page Consumer.
42
43Le premier n'est reconnu que sur macOS, alors que le dernier, `KC_SLEP` et `KC_WAKE` sont supportés par les trois principaux systèmes d'exploitation. Il est donc recommandé de les utiliser à la place. Sous Windows, ces touches prennent effet immédiatement, mais sur macOS, elles doivent être maintenues enfoncées jusqu'à ce qu'une boîte de dialogue apparaisse.
44
45## Modificateur "One Shot"
46
47Cette fonctionnalité permet de corriger un problème avec la touche Shift. En effet, il arrive de saisir plusieurs majuscules en ne voulant en saisir qu'une sur un mot. Ex: `CEtte` à la place de `Cette`. La fonctionnalité «One shot» shift permet de corriger ça.
48
49https://github.com/tmk/tmk_keyboard/issues/67
50
51## Le modificateur d'un calque reste bloqué
52
53Les touches de modification ou les calques peuvent être bloquées si la commutation de calque n'est pas configurée correctement.
54Pour les touches de modification et les actions de calque, vous devez placer `KC_TRANS` sur la même position du calque de destination afin de désenregistrer la clé de modificateur ou de revenir au calque précédent lors de la libération.
55
56* https://github.com/tmk/tmk_core/blob/master/doc/keymap.md#31-momentary-switching
57* https://geekhack.org/index.php?topic=57008.msg1492604#msg1492604
58* https://github.com/tmk/tmk_keyboard/issues/248
59
60## Support de touche à verrouillage mécanique
61
62Cette fonctionnalité permet l'usage de *touches à verrouillage mécanique* comme [ces interrupteurs Alps](https://deskthority.net/wiki/Alps_SKCL_Lock). Vous pouvez l'activer en ajoutant ceci à votre `config.h`:
63
64```
65#define LOCKING_SUPPORT_ENABLE
66#define LOCKING_RESYNC_ENABLE
67```
68
69Une fois la fonction activée, utilisez les keycodes `KC_LCAP`, `KC_LNUM` et `KC_LSCR` dans votre keymap.
70
71Des vieux claviers mécaniques ont parfois des touches à verrouillage, mais les claviers modernes n'en sont pas équipés. ***Vous n'avez pas besoin de cette fonction dans la majorité des cas et devez utiliser les keycodes `KC_CAPS`, `KC_NLCK` et `KC_SLCK`.***
72
73## Ajouter des caractères spéciaux autres que ASCII comme la cédille 'Ç'
74
75Voir la fonctionnalité [Unicode](feature_unicode.md).
76
77## Touche `Fn` sur macOS
78
79Contrairement à la plupart des touches Fn, celle des claviers Apple a son propre code d'activation... en quelque sorte. Il remplace le sixième code d'activation dans un rapport de base 6KRO HID - de sorte qu'un clavier Apple ne contient en réalité que 5KRO.
80
81Il est techniquement possible de demander à QMK d’envoyer ce keycode. Cependant, cela nécessite une modification du format du rapport pour ajouter l'état de la touche Fn.
82Pire encore, ce keycode n'est reconnu que si les identifiants du clavier VID et PID correspondent à ceux d'un vrai clavier Apple. Malheureusement QMK ne peut juridiquement prendre en charge cette fonctionnalité et il y a peu de chance que la situation s'améliore.
83
84Voir [cette issue](https://github.com/qmk/qmk_firmware/issues/2179) pour des informations détaillées.
85
86## Touches Media sous Mac OSX
87
88#### KC_MNXT et KC_MPRV ne fonctionnent pas sous Mac
89
90Utilisez `KC_MFFD`(`KC_MEDIA_FAST_FORWARD`) et `KC_MRWD`(`KC_MEDIA_REWIND`) à la place de `KC_MNXT` et `KC_MPRV`.
91Voir https://github.com/tmk/tmk_keyboard/issues/195
92
93## Touches supportées sous Mac OSX?
94
95Vous pouvez connaître les keycodes supportés par OSX en lisant ce code source.
96
97`usb_2_adb_keymap` contient les tableaux des pages Keyboard/Keypad vers les scancodes ADB (keycodes interne à OSX).
98
99https://opensource.apple.com/source/IOHIDFamily/IOHIDFamily-606.1.7/IOHIDFamily/Cosmo_USB2ADB.c
100
101Et `IOHIDConsumer::dispatchConsumerEvent` s'occupe des utilisations Consumer page.
102
103https://opensource.apple.com/source/IOHIDFamily/IOHIDFamily-606.1.7/IOHIDFamily/IOHIDConsumer.cpp
104
105## Touches JIS dans Mac OSX
106
107Les touches de clavier spécifiques JIS comme `無変換(Muhenkan)`, `変換(Henkan)`, `ひらがな(hiragana)` ne sont pas reconnues par OSX. Vous pouvez utiliser **Seil** pour les activer, esssayez les options suivantes.
108
109* Activer la touche NFER sur clavier PC
110* Activer la touche XFER sur clavier PC
111* Activer la touche KATAKANA sur clavier PC
112
113https://pqrs.org/osx/karabiner/seil.html
114
115## RN-42 Bluetooth ne fonctionne pas avec Karabiner
116
117Karabiner - Outil de Keymapping sous Mac OSX - Ignore les entrées du module RN-42. Vous devez activer cette option pour rendre Karabiner compatible avec votre clavier.
118https://github.com/tekezo/Karabiner/issues/403#issuecomment-102559237
119
120Plus de détails sur ce problème sur les liens suivants.
121https://github.com/tmk/tmk_keyboard/issues/213
122https://github.com/tekezo/Karabiner/issues/403
123
124## Esc et <code>&#96;</code> sur une touche simple.
125
126Cette fonctionnalité permet d'utiliser une touche à la fois comme touche Échap ou une touche `§` (En Azerty) selon le cas d’utilisation. Cela est très utile sur un clavier de petite taille.
127
128Voir la fonctionnalité [Grave Escape](feature_grave_esc.md).
129
130## Eject sur Mac OSX
131
132Le keycode`KC_EJCT` fonctionne sous OSX. https://github.com/tmk/tmk_keyboard/issues/250
133
134Il semble que Windows 10 ignore le code et Linux/Xorg le reconnaît mais n'a pas de mapping par défaut.
135
136Nous ne sommes pas sûr quel keycode est utilisé pour la touche Eject sur les claviers Apple officiels. HHKB utilise `F20` pour la touche Eject (`Fn+f`) lorsqu'il est en mode Mac, mais ce n'est probablement pas la même chose que le keycode Eject d'Apple.
137
138## Qu'est-ce que `weak_mods` et `real_mods` dans `action_util.c`
139
140___TO BE IMPROVED___
141
142real_mods est prévu pour retenir l'état des touches modificateur réelles/physiques, alors que weak_mods ne retient l'état que des modificateurs temporaires ou virtuels qui ne devraient pas affecter l'état des touches modificaterus réelles.
143
144Par exemple, disons que vous maintenez la touche physique "shift gauche" et tapez ACTION_MODS_KEY(LSHIFT, KC_A),
145
146en weak_mods,
147
148* (1) maintenir shift gauche : real_mods |= MOD_BIT(LSHIFT)
149* (2) appuyer ACTION_MODS_KEY(LSHIFT, KC_A): weak_mods |= MOD_BIT(LSHIFT)
150* (3) lâcher ACTION_MODS_KEY(LSHIFT, KC_A): weak_mods &= ~MOD_BIT(LSHIFT)
151real_mods garde sur état modificateur.
152
153sans weak_mods,
154
155* (1) maintenir shift gauche : real_mods |= MOD_BIT(LSHIFT)
156* (2) appuyer ACTION_MODS_KEY(LSHIFT, KC_A): real_mods |= MOD_BIT(LSHIFT)
157* (3) lâcher ACTION_MODS_KEY(LSHIFT, KC_A): real_mods &= ~MOD_BIT(LSHIFT)
158ici real_mods a perdu son état pour 'shift gauche physique'.
159
160weak_mods est ORed avec real_mods lorsque le rapport du clavier est envoyé.
161https://github.com/tmk/tmk_core/blob/master/common/action_util.c#L57
diff --git a/docs/fr-fr/flashing.md b/docs/fr-fr/flashing.md
deleted file mode 100644
index 9f5493194..000000000
--- a/docs/fr-fr/flashing.md
+++ /dev/null
@@ -1,238 +0,0 @@
1# Instructions pour flasher et informations sur les bootloader
2
3Les 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.
4
5Si 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`.
6
7## DFU
8
9Le 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.
10
11Pour 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.
12
13```make
14# Bootloader selection
15# Teensy halfkay
16# Pro Micro caterina
17# Atmel DFU atmel-dfu
18# LUFA DFU lufa-dfu
19# QMK DFU qmk-dfu
20# ATmega32A bootloadHID
21# ATmega328P USBasp
22BOOTLOADER = atmel-dfu
23```
24
25Méthodes de flash compatibles :
26
27* [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases) (interface graphique recommandé)
28* [dfu-programmer](https://github.com/dfu-programmer/dfu-programmer) / `:dfu` avec QMK (outil en ligne de commande recommandé)
29
30Ordre des actions:
31
321. Pressez le keycode `RESET`, ou appuyez sur le bouton physique RESET ou alors créez un contact entre RST et GND.
332. Attendez que l'OS detecte l'appareil.
343. Éffacez la mémoire, cela peut être fait automatiquement.
354. Flasher le fichier .hex.
365. Redémarrez l'appareil en mode «application», cela peut être fait automatiquement.
37
38Alternativement:
39
40 make <keyboard>:<keymap>:dfu
41
42### DFU QMK
43
44QMK 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):
45
46 #define QMK_ESC_OUTPUT F1 // usually COL
47 #define QMK_ESC_INPUT D5 // usually ROW
48 #define QMK_LED E6
49 #define QMK_SPEAKER C6
50
51Le 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.
52
53Pour génerer le bootloader, utilisez la cible `bootloader`. Exemple: `make planck/rev4:default:bootloader`.
54
55Pour 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`.
56
57### Commandes DFU
58
59Il y a plusieurs commandes DFU que vous pouvez utiliser pour flasher le firmware sur un appareil DFU.
60
61* `: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.
62* `:dfu-ee` - Cette option flash un fichier `.eep` à la place d'un fichier `.hex`. Ce cas est plutôt rare.
63* `: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_
64* `: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_
65
66## Caterina
67
68Les 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.
69
70Pour vérifier la compatibilité avec un bootloader Caterina, vérifiez que ce bloc est présent dans votre fichier `rules.mk`:
71
72```make
73# Bootloader selection
74# Teensy halfkay
75# Pro Micro caterina
76# Atmel DFU atmel-dfu
77# LUFA DFU lufa-dfu
78# QMK DFU qmk-dfu
79# ATmega32A bootloadHID
80# ATmega328P USBasp
81BOOTLOADER = caterina
82```
83
84Flashers compatibles:
85
86* [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases) (Interface graphique recommandée)
87* [avrdude](https://www.nongnu.org/avrdude/) avec avr109 / `:avrdude` (Outil en ligne de commande recommandé)
88* [AVRDUDESS](https://github.com/zkemble/AVRDUDESS)
89
90Séquence de flash :
91
921. 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.
932. Attendez que l'OS détecte l'appareil.
943. Flasher le fichier .hex.
954. Attendez que l'appareil redémarre automatiquement.
96
97ou, utilisez:
98
99 make <keyboard>:<keymap>:avrdude
100
101#### Commandes Caterina
102
103Il existe un certain nombre de commandes DFU que vous pouvez utiliser pour mettre à jour le firmware sur un périphérique DFU:
104
105* `: 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.
106* `: 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_
107* `: 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.
108* `: 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.
109
110## Halfkay
111
112Halfkay 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.
113
114Pour vérifier la compatibilité avec le booloader Halfkay, vérifiez que ce bloc est présent dans votre fichier `rules.mk`:
115
116```make
117# Bootloader selection
118# Teensy halfkay
119# Pro Micro caterina
120# Atmel DFU atmel-dfu
121# LUFA DFU lufa-dfu
122# QMK DFU qmk-dfu
123# ATmega32A bootloadHID
124# ATmega328P USBasp
125BOOTLOADER = halfkay
126```
127
128Flasher compatibles:
129
130* [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases) (Interface graphique recomandée)
131* [Teensy Loader](https://www.pjrc.com/teensy/loader.html) (petit utilitaire ultra simple)
132 [Teensy Loader en ligne de commande](https://www.pjrc.com/teensy/loader_cli.html) (Outil en ligne de commande recommandé)
133
134Séquence de flash:
135
1361. Pressez la touche du keycode `RESET`, ou reliez les ports RST et GND rapidement. Vous avez ensuite 7 secondes pour réaliser le flash.
1372. Attendez que l'OS détecte l'appareil.
1383. Flasher le fichier .hex.
1394. Redémarrez l'appareil en mode «application». Cela peut être fait automatiquement.
140
141## USBasploader
142
143USBasploader 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.
144
145Pour vérifier la compatibilité avec le booloader USBasploader, vérifiez que ce bloc est présent dans votre fichier `rules.mk`:
146
147```make
148# Bootloader selection
149# Teensy halfkay
150# Pro Micro caterina
151# Atmel DFU atmel-dfu
152# LUFA DFU lufa-dfu
153# QMK DFU qmk-dfu
154# ATmega32A bootloadHID
155# ATmega328P USBasp
156BOOTLOADER = USBasp
157```
158
159Flashers compatibles:
160
161* [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases) (Interface graphique recommandé)
162* [avrdude](https://www.nongnu.org/avrdude/) avec le programmeur `usbasp`.
163* [AVRDUDESS](https://github.com/zkemble/AVRDUDESS)
164
165Séquence de flash:
166
1671. 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.
1682. Attendez que l'OS détecte l'appareil.
1693. Flasher le fichier .hex.
1704. Redémarrez l'appareil en mode «application». Cela peut être fait automatiquement.
171
172## BootloadHID
173
174BootloadHID 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.
175
176Pour vérifier la compatibilité avec le bootloader bootloadHID, vérifiez que ce bloc existe dans votre fichier `rules.mk` :
177
178```make
179# Bootloader selection
180# Teensy halfkay
181# Pro Micro caterina
182# Atmel DFU atmel-dfu
183# LUFA DFU lufa-dfu
184# QMK DFU qmk-dfu
185# ATmega32A bootloadHID
186# ATmega328P USBasp
187BOOTLOADER = bootloadHID
188```
189
190Utilitaires de flash compatibles:
191
192* [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash) (Utilitaire avec interface graphique recommandé)
193* [bootloadhid Command Line](https://www.obdev.at/products/vusb/bootloadhid.html) / `:BootloadHID` avec QMK (utilitaire en ligne de commande recommandé)
194
195Séquence de flash
196
1971. Entrez dans le bootloader en utilisant l'une de ces méthodes:
198 * Pressez la touche du keycode `RESET` (Cela ne fonctionnera pas sur certains appareils).
199 * Verrouillez la touche «Salt» tout en branchant le clavier (Généralement ce principe est documenté dans le fichier readme du clavier)
2002. Attendez que l'OS détecte l'appareil.
2013. Flasher le fichier .hex.
2024. Redémarrez l'appareil en mode «application». Cela peut être fait automatiquement.
203
204Ou alors:
205
206 make <keyboard>:<keymap>:bootloadHID
207
208## STM32
209
210Tous 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.
211
212Pour le moment, aucune variable `BOOTLOADER` n'est nécessaire dans le fichier `rules.mk`.
213
214Flashers compatibles:
215
216* [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases) (interface graphique recommandé)
217* [dfu-util](https://github.com/Stefan-Schmidt/dfu-util) / `:dfu-util` (utilitaire en ligne de commande recommandé)
218
219Séquence pour flasher:
220
2211. Entrez dans le bootloader en utilisant l'une de ces méthodes:
222 * Utilisez une touche sur laquelle le keycode `RESET` (Cela peut ne pas fonctionner sur les appareils STM32F042)
223 * Si un circuit de réinitialisation (Reset) est présent alors utilisé le bouton qui lui est dédié.
224 * 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.
2252. Attendre que l'os détecte l'appareil.
2263. Flasher un fichier `.bin`.h
227 * Vous allez recevoir un avertissement à propos de la signature DFU. Ignorez-la.
2284. Réinitialisez l'appareil en mode «application». Cela peut être fait automatiquement.
229 * 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é.
230
231### Commandes STM32
232
233Il y a différentes commandes que vous pouvez utiliser pour flasher un firmware dans un appareil STM32:
234
235* `:dfu-util` - C'est l'option standard pour flasher un appareil STM32. Le script attendra qu'un bootloader STM32 soit présent.
236* `: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é.
237* `: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é.
238* `: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 fedb18c76..000000000
--- a/docs/fr-fr/getting_started_getting_help.md
+++ /dev/null
@@ -1,15 +0,0 @@
1# Trouver de l'aide
2
3Il y a beaucoup de ressources pour trouver de l'aide avec QMK.
4
5## Chat temps-réel
6
7Vous 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.
8
9## Sous-Reddit OLKB
10
11Le forum officiel de QMK est [/r/olkb](https://reddit.com/r/olkb) sur [reddit.com](https://reddit.com).
12
13## Tickets GitHub
14
15Vous 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 522b09a03..000000000
--- a/docs/fr-fr/getting_started_github.md
+++ /dev/null
@@ -1,66 +0,0 @@
1# Comment utiliser GitHub avec QMK
2
3GitHub 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.
4
5?> 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.
6
7Commencez 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":
8
9![Fork on GitHub](https://i.imgur.com/8Toomz4.jpg)
10
11Si 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":
12
13![Download from GitHub](https://i.imgur.com/N1NYcSz.jpg)
14
15Faites attention à sélectionner "HTTPS", et sélectionnez le lien et copiez-le:
16
17![HTTPS link](https://i.imgur.com/eGO0ohO.jpg)
18
19Ensuite, entrez `git clone --recurse-submodules ` dans la ligne de commande, et collez votre lien:
20
21```
22user@computer:~$ git clone --recurse-submodules https://github.com/whoeveryouare/qmk_firmware.git
23Cloning into 'qmk_firmware'...
24remote: Enumerating objects: 9, done.
25remote: Counting objects: 100% (9/9), done.
26remote: Compressing objects: 100% (5/5), done.
27remote: Total 183883 (delta 5), reused 4 (delta 4), pack-reused 183874
28Receiving objects: 100% (183883/183883), 132.90 MiB | 9.57 MiB/s, done.
29Resolving deltas: 100% (119972/119972), done.
30...
31Submodule path 'lib/chibios': checked out '587968d6cbc2b0e1c7147540872f2a67e59ca18b'
32Submodule path 'lib/chibios-contrib': checked out 'ede48346eee4b8d6847c19bc01420bee76a5e486'
33Submodule path 'lib/googletest': checked out 'ec44c6c1675c25b9827aacd08c02433cccde7780'
34Submodule path 'lib/lufa': checked out 'ce10f7642b0459e409839b23cc91498945119b4d'
35```
36
37Vous 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:
38
39```
40user@computer:~$ git add .
41user@computer:~$ git commit -m "adding my keymap"
42[master cccb1608] adding my keymap
43 1 file changed, 1 insertion(+)
44 create mode 100644 keyboards/planck/keymaps/mine/keymap.c
45user@computer:~$ git push
46Counting objects: 1, done.
47Delta compression using up to 4 threads.
48Compressing objects: 100% (1/1), done.
49Writing objects: 100% (1/1), 1.64 KiB | 0 bytes/s, done.
50Total 1 (delta 1), reused 0 (delta 0)
51remote: Resolving deltas: 100% (1/1), completed with 1 local objects.
52To https://github.com/whoeveryouare/qmk_firmware.git
53 + 20043e64...7da94ac5 master -> master
54```
55
56Vos changements existent maintenant dans votre fork sur GitHub. Si vous allez à cette adresse (`https://github.com/<whoeveryouare>/qmk_firmware`), vous pouvez créer un nouveau "Pull Request" en cliquant sur ce bouton:
57
58![New Pull Request](https://i.imgur.com/DxMHpJ8.jpg)
59
60Maintenant, vous pourrez voir exactement ce que vous avez commité. Si ça vous semble bien, vous pouvez le finaliser en cliquant sur "Create Pull Request":
61
62![Create Pull Request](https://i.imgur.com/Ojydlaj.jpg)
63
64Une fois transmis, nous pourrons vous parler de vos changements, vous demander de faire des changements, et éventuellement de les accepter!
65
66Merci 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 b2711a167..000000000
--- a/docs/fr-fr/getting_started_introduction.md
+++ /dev/null
@@ -1,62 +0,0 @@
1# Introduction
2
3Le 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
7QMK 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
11Dans 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
15Dans 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
17A 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
27Pour plus d'information sur la structure du projet, voyez [Directives clavier QMK](hardware_keyboard_guidelines.md).
28
29### Structure d'une Keymap
30
31Dans 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
40Le 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
46Le 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
52Ensuite, pour surcharger l'option du fichier `config.h` précédent, vous devez `#undef` puis `#define` l'option à nouveau.
53
54Voici à 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```
diff --git a/docs/fr-fr/newbs.md b/docs/fr-fr/newbs.md
deleted file mode 100644
index 6d848b11f..000000000
--- a/docs/fr-fr/newbs.md
+++ /dev/null
@@ -1,23 +0,0 @@
1# Le Guide pour débutant complet à QMK
2
3QMK est un firmware Open Source pour votre clavier mécanique. Vous pouvez utiliser QMK pour customiser votre clavier de manière simple et puissante. Tout le monde, du débutant complet au développeur avancé, ont utilisé avec succès QMK pour customiser leur clavier. Ce guide vous aidera à faire de même, quelles que soient vos compétences.
4
5Vous voulez savoir si votre clavier peut utiliser QMK? Si c'est un clavier mécanique que vous avez vous-même construit, il y a de bonnes chances que vous pouvez. Nous supportons un [grand nombre de "hobbyist boards"](https://qmk.fm/keyboards), donc même si votre clavier ne peut pas utiliser QMK, vous ne devriez pas avoir trop de problème pour en trouver un qui vous convienne.
6
7## Vue d'ensemble
8
9Il y a 7 sections principales dans ce guide:
10
11* [Pour débuter](fr-FR/newbs_getting_started.md)
12* [Compiler votre premier firmware en utilisant la ligne de commande](fr-FR/newbs_building_firmware.md)
13* [Compiler votre premier firmware en utilisant l'interface graphique en ligne](fr-FR/newbs_building_firmware_configurator.md)
14* [Flasher le Firmware](fr-FR/newbs_flashing.md)
15* [Test et Débuggage](fr-FR/newbs_testing_debugging.md)
16* [Bonnes pratiques Git](fr-FR/newbs_best_practices.md)
17* [Ressources d'apprentissage](fr-FR/newbs_learn_more_resources.md)
18
19Ce guide a pour but principal d'aider quelqu'un qui n'a jamais compilé de logiciel avant. Les recommandations et les choix qu'il contient vont donc dans ce sens. Il y a des méthodes alternatives pour beaucoup de ces procédures, et nous supportons la plupart de ces alternatives. Si vous avez un doute sur comment accomplir une tâche, vous pouvez [nous demander de l'aide](fr-FR/getting_started_getting_help.md).
20
21## Ressources additionnelles
22
23* [Thomas Baart's QMK Basics Blog](https://thomasbaart.nl/category/mechanical-keyboards/firmware/qmk/qmk-basics/) – Un blog créé par un utilisateur qui couvre les bases de l'utilisation du Firmware QMK, vue d'un point de vue d'un nouvel utilisateur (anglais).
diff --git a/docs/fr-fr/newbs_best_practices.md b/docs/fr-fr/newbs_best_practices.md
deleted file mode 100644
index ec68a5e3e..000000000
--- a/docs/fr-fr/newbs_best_practices.md
+++ /dev/null
@@ -1,161 +0,0 @@
1# Bonnes Pratiques
2
3## Ou, "Comment j'ai appris à ne plus m'en faire et aimer Git."
4
5Ce document a pour but d'apprendre aux novices les meilleures solutions pour faciliter la contribution à QMK. Nous allons étudier le processus de contribution à QMK, détaillant quelques moyens de rendre cette tâche plus simple. Nous allons faire quelques erreurs afin de vous apprendre à les résoudre.
6
7Ce document suppose les choses suivantes:
8
91. Vous avez un compte GitHub, et avez [créé un "fork" pour le dépôt qmk_firmware](fr-FR/getting_started_github.md) avec votre compte.
102. Vous avez [configuré votre environnement de compilation](fr-FR/newbs_getting_started.md?id=environment-setup).
11
12## La branche master de votre fork: Mettre à jour souvent, ne jamais commit
13
14Il est hautement recommandé pour le développement de QMK, peu importe ce qui est fait ou où, de garder votre branche `master` à jour, mais de ne ***jamais*** commit dessus. A la place, faites tous vos changements dans une branche de développement et crééz des "pull requests" de votre branche lorsque vous développez.
15
16Pour réduire les chances de conflits de fusion (merge) &mdash; des cas où deux ou plus d'utilisateurs ont édité la même section d'un fichier en parallèle &mdash; gardez votre branche `master` relativement à jour et démarrez chaque nouveau développement en créant une nouvelle branche.
17
18### Mettre à jour votre branche master
19
20Pour garder votre branche `master` à jour, il est recommandé d'ajouter le dépôt du firmware QMK comme un dépôt distant (remote) dans git. pour se faire, ouvrez votre interface de ligne de commande Git et entrez:
21
22```bash
23git remote add upstream https://github.com/qmk/qmk_firmware.git
24```
25
26Pour vérifier que le dépôt a bien été ajouté, lancez la commande `git remote -v`, qui devrait retourner le résultat suivant:
27
28```bash
29$ git remote -v
30origin https://github.com/<your_username>/qmk_firmware.git (fetch)
31origin https://github.com/<your_username>/qmk_firmware.git (push)
32upstream https://github.com/qmk/qmk_firmware.git (fetch)
33upstream https://github.com/qmk/qmk_firmware.git (push)
34```
35
36Maintenant que c'est fait, vous pouvez vérifier les mises à jour au dépôt en lançant `git fetch upstream`. Cela récupère les branches et les tags &mdash; appelé de manière générale "refs" &mdash; du dépôt QMK, qui a maintenant le surnom `upstream`. Nous pouvons maintenant comparer les données sur notre "fork" `origin` à celles contenues par QMK.
37
38Pour mettre à jour la branche master de votre "fork", lancez les commandes suivantes (en appuyant sur Enter après chaque ligne):
39
40```bash
41git checkout master
42git fetch upstream
43git pull upstream master
44git push origin master
45```
46
47Cela vous change la branche courante en master, synchronise les données de références du dépôt QMK vers votre ordinateur. La commande pull tire les données de références vers votre branche courante puis les y téleverse. La commande push permet de pousser la branche courante (master) vers votre fork GitHub.
48
49### Faire des changements
50
51Pour faire des changements, créez une nouvelle branche en entrant:
52
53```bash
54git checkout -b dev_branch
55git push --set-upstream origin dev_branch
56```
57
58Ceci crée une branche nommée `dev_branch`, bascule vers cette branche, et ensuite sauvegarde cette nouvelle branche vers votre fork. L'argument `--set-upstream` demande à git d'utiliser votre fork et la branche `dev_branch` à chaque fois que vous utilisez `git push` ou `git pull` depuis cette branche. Vous ne devez l'utiliser que pour le premier "push", après cela, vous pouvez utiliser simplement `git push` ou `git pull`, sans le reste des arguments.
59
60!> Avec `git push`, vous pouvez utiliser `-u` à la place de `--set-upstream` &mdash; `-u` est un alias pour `--set-upstream`.
61
62Vous pouvez appeler votre branche à peu près comme vous voulez, toutefois il est recommandé d'utiliser un nom qui est lié aux changements que vous allez faire.
63
64Par défaut, `git checkout -b` va faire de la branche actuelle la branche de base de votre nouvelle branche. Vous pouvez définir la base de votre nouvelle branche comme étant n'importe quelle branche existante qui n'est pas la courante en utilisant la commande:
65
66```bash
67git checkout -b dev_branch master
68```
69
70Maintenant que vous avez une branche de développement, ouvrez votre éditeur de texte et faites vos changements. Il est recommandé de faire beaucoup de petits commits dans votre branche. Ainsi, un changement qui crée un problème peut être plus facilement retracé et annulé si nécessaire. Pour faire un changement, éditez et sauvez n'importe quel fichier qui doit être mis à jour, ajoutez les à la *zone de staging* de Git, et commitez les vers votre branche:
71
72```bash
73git add path/to/updated_file
74git commit -m "My commit message."
75```
76
77`git add` ajoute les fichiers qui ont été changés dans la *zone de staging* de Git, qui est sa "zone de chargement". Elle contient tous les changements qui vont être *validés* (committed) par `git commit`, qui sauvegarde les changements vers le dépôt. Utilisez des messages de validation descriptifs afin que vous puissiez savoir ce qui a changé d'un coup d'oeil.
78
79!> Si vous changez beaucoup de fichiers, mais tous les fichiers font partie du même changement, vous pouvez utiliser `git add .` pour ajouter tous les fichiers changés dans le répertoire courant, plutôt que d'avoir à ajouter chaque fichier individuellement.
80
81### Publier Vos Changements
82
83La dernière étape est de pousser vos changements vers votre fork. Pour ce faire, entrez `git push`. Git publie maintenant l'état courant de `dev_branch` vers votre fork.
84
85## Résoudre Les Conflits De Merge
86
87Parfois, lorsque votre travail sur une branche met beaucoup de temps à se compléter, des changements réalisés par d'autres peuvent entrer en conflit avec les changements que vous avez fait sur votre branche au moment où vous avez ouvert un pull request. Ceci est appelé un *conflit de merge*, et c'est ce qui arrive lorsque plusieurs personnes modifient les mêmes parties de mêmes fichiers.
88
89### Rebaser Vos Changements
90
91Un *rebase* est la manière pour Git de prendre les changements qui ont été faits à un point, les annuler, et les réappliquer sur un autre point. Dans le cas d'un conflit de merge, vous pouvez rebaser votre branche pour récupérer les changements qui ont été faits entre le moment où vous avez créé votre branche et le présent.
92
93Pour démarrer, lancez les commandes suivantes:
94
95```bash
96git fetch upstream
97git rev-list --left-right --count HEAD...upstream/master
98```
99
100La commande `git rev-list` retourne le nombre de commits qui diffère entre la branche courante et la branche master de QMK. Nous lançons `git fetch` en premier afin d'être sûr que les refs qui représentent l'état courant du dépôt upstream soient à jour. Le résultat de la commande `git rev-list` retourne deux nombres:
101
102```bash
103$ git rev-list --left-right --count HEAD...upstream/master
1047 35
105```
106
107Le premier nombre représente combien il y a eu de commits sur la branche courante depuis qu'elle a été créée, et le second nombre est combien de commits ont été faits sur la branche `upstream/master` depuis que la branche a été créée et, ainsi, les changements qui ne sont pas enregistrés sur la branche courante.
108
109Maintenant que l'état actuel de la branche courante et la branche upstream sont connus, nous pouvons maintenant démarrer une opération de rebase:
110
111```bash
112git rebase upstream/master
113```
114
115Ceci dit à Git d'annuler les commits de la branche courante puis de les réappliquer sur la branche master de QMK.
116
117```bash
118$ git rebase upstream/master
119First, rewinding head to replay your work on top of it...
120Applying: Commit #1
121Using index info to reconstruct a base tree...
122M conflicting_file_1.txt
123Falling back to patching base and 3-way merge...
124Auto-merging conflicting_file_1.txt
125CONFLICT (content): Merge conflict in conflicting_file_1.txt
126error: Failed to merge in the changes.
127hint: Use 'git am --show-current-patch' to see the failed patch
128Patch failed at 0001 Commit #1
129
130Resolve all conflicts manually, mark them as resolved with
131"git add/rm <conflicted_files>", then run "git rebase --continue".
132You can instead skip this commit: run "git rebase --skip".
133To abort and get back to the state before "git rebase", run "git rebase --abort".
134```
135
136Ceci nous dit que nous avons un conflit de merge, et nous donne le nom du fichier en conflit. Ouvrez le fichier conflictuel dans votre éditeur de texte et, quelque part dans le fichier, vous trouverez quelque chose comme ça:
137
138```bash
139<<<<<<< HEAD
140<p>For help with any issues, email us at support@webhost.us.</p>
141=======
142<p>Need help? Email support@webhost.us.</p>
143>>>>>>> Commit #1
144```
145
146La ligne `<<<<<<< HEAD` montre le début d'un conflit de merge et la ligne `>>>>>>> Commit #1` indique la fin, avec les sections conflictuelles séparées par `=======`. La partie du côté `HEAD` vient de la version du fichier provenant de la branche master de QMK, et la partie marquée avec le numéro du commit provient de la branche courrante.
147
148Parce que Git suis *les changements des fichiers*, plutôt que les contenus des fichiers directement, si Git ne peut pas trouver le texte qu'il y avait dans le fichier avant que le commit soit fait, il ne saura pas comment modifier le fichier. Modifier le fichier à nouveau va résoudre le conflit. Faites votre changement, et sauvez le fichier.
149
150```bash
151<p>Need help? Email support@webhost.us.</p>
152```
153
154Maintenant, lancez:
155
156```bash
157git add conflicting_file_1.txt
158git rebase --continue
159```
160
161Git enregistre le changement dans le fichier conflictuel, et continue à appliquer les commits depuis votre branche jusqu'à ce qu'il arrive à la fin.
diff --git a/docs/fr-fr/newbs_building_firmware.md b/docs/fr-fr/newbs_building_firmware.md
deleted file mode 100644
index 81870d31e..000000000
--- a/docs/fr-fr/newbs_building_firmware.md
+++ /dev/null
@@ -1,81 +0,0 @@
1# Compiler Votre Premier Firmware
2
3Maintenant que vous avez configuré votre environnement de build, vous être prêts à compiler un firmware customisé. Pour cette section, nous allons utiliser trois programmes différents: votre explorateur de fichier, votre éditeur de texte et votre fenêtre de terminal. Gardez les 3 ouverts jusqu'à ce que vous ayez terminé et soyez content de votre firmware de clavier.
4
5Si vous avez fermé et rouvert votre fenêtre de terminal depuis le démarrage de ce guide, n'oubliez pas de `cd qmk_firmware` afin que votre terminal soit dans le bon répertoire.
6
7## Naviguez vers votre répertoire keymaps
8
9Démarrez par naviguer dans le répertoire `keymaps` de votre clavier.
10
11?> Si vous êtes sous macOS ou Windows, il y a des commandes que vous pouvez utiliser pour facilement ouvrir le dossier keymaps.
12
13?> macOS:
14
15 open keyboards/<keyboard_folder>/keymaps
16
17?> Windows:
18
19 start .\\keyboards\\<keyboard_folder>\\keymaps
20
21## Créez une copie de la keymap `default`
22
23Une fois le dossier `keymaps` ouvert, créez une copie du répertoire `default`. Nous vous recommandons de nommer ce répertoire de la même manière que votre nom d'utilisateur GitHub. Vous pouvez aussi utiliser le nom que vous voulez, tant qu'il contient uniquement des lettres minuscules, des nombres et le caractère souligné (_).
24
25Afin d'automatiser ce processus, vous avez aussi l'option de lancer le script `new_keymap.sh`.
26
27Naviguez vers le répertoire `qmk_firmware/util` et tapez ce qui suit:
28
29```
30./new_keymap.sh <keyboard path> <username>
31```
32
33Par exemple, pour un utilisateur s'appeleant John, essayant de créer une nouvelle keymap pour le 1up60hse, il taperait:
34
35```
36./new_keymap.sh 1upkeyboards/1up60hse john
37```
38
39## Ouvrez `keymap.c` dans votre éditeur de texte préféré
40
41Ouvrez votre fichier `keymap.c`. Dans ce fichier, vous trouverez la structure qui contrôle comment votre clavier se comporte. En haut du fichier `keymap.c` il peut y avoir quelques `defines` et `enums` qui rendent la keymap plus simple à lire. Plus bas, vous trouverez une ligne telle que celle-ci:
42
43 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
44
45Cette ligne indique le début d'une liste de calques (layers). En dessous, vous trouverez des lignes contenant soit `LAYOUT`, soit `KEYMAP` et ces lignes indiquent le début d'un calque. En dessous de cette ligne se trouve la liste des touches qui comprennent ce calque particulier.
46
47!> Lorsque vous éditez votre fichier keymap, faites attention à ne pas ajouter ou enlever une virgule. Si vous le faites, vous aller empêcher votre firmware de compiler et il ne sera pas facile de trouver où la virgule est manquante ou en trop.
48
49## Customisez le layout à votre goût
50
51Libre à vous de choisir comment compléter cette étape. Faites le petit changement qui vous dérange ou retravaillez tout de zéro. Vous pouvez supprimer des calques si vous ne les utilisez pas tous, ou ajouter des calques jusqu'à un maximum de 32. Vérifiez la documentation suivante pour trouver ce que vous pouvez définir ici:
52
53* [Keycodes](keycodes.md)
54* [Fonctionnalités](features.md)
55* [FAQ](faq.md)
56
57?> Lorsque vous découvrez comment des keymaps fonctionnent, faites de petits changements. De gros changements rendent le débuggage des problèmes éventuels plus difficile.
58
59## Compilez votre firmware
60
61Lorsque les changements de votre keymap sont complets, vous allez devoir compiler le firmware. Pour ce faire, retournez à votre terminal et lancez la commande de compilation:
62
63 make <my_keyboard>:<my_keymap>
64
65Par exemple, si votre keymap s'appelle "xyverz" et vous compilez une keymap pour une plank rev5, vous allez utiliser cette commande:
66
67 make planck/rev5:xyverz
68
69Durant la compilation, vous allez avoir beaucoup de messages sur l'écran vous informant de quels fichiers sont en train d'être compilés. Il devrait se terminer avec des messages qui ressemblent comme suit:
70
71```
72Linking: .build/planck_rev5_xyverz.elf [OK]
73Creating load file for flashing: .build/planck_rev5_xyverz.hex [OK]
74Copying planck_rev5_xyverz.hex to qmk_firmware folder [OK]
75Checking file size of planck_rev5_xyverz.hex [OK]
76 * File size is fine - 18392/28672
77```
78
79## Flasher votre firmware
80
81Allez sur la page [Flasher le firmware](fr-FR/newbs_flashing.md) pour apprendre comment écrire votre nouveau firmware sur votre clavier.
diff --git a/docs/fr-fr/newbs_building_firmware_configurator.md b/docs/fr-fr/newbs_building_firmware_configurator.md
deleted file mode 100644
index d06242f39..000000000
--- a/docs/fr-fr/newbs_building_firmware_configurator.md
+++ /dev/null
@@ -1,105 +0,0 @@
1# Configurateur de QMK
2
3Le [Configurateur de QMK](https://config.qmk.fm) est une interface graphique en ligne permettant de générer des fichiers "hex" du firmware de QMK.
4
5?> **S'il vous plaît, suivez les étapes suivantes dans l'ordre.**
6
7Regardez le [Tutoriel vidéo](https://youtu.be/tx54jkRC9ZY)https://www.youtube.com/watch?v=-imgglzDMdY)
8
9Le configurateur de QMK fonctionne mieux avec Chrome et Firefox.
10
11!> **Les fichiers d'autres outils, tels que KLE ou kbfirmware ne seront pas compatibles avec le configurateur QMK. Ne les chargez pas, ne les importez pas. Le configurateur QMK est un outil DIFFERENT.**
12
13## Sélectionner votre clavier
14
15Cliquez la boîte déroulante et sélectionnez le clavier pour lequel vous voulez créer une keymap.
16
17?> Si votre clavier a plusieurs versions, faites attention à utiliser la bonne.
18
19Je vais le répéter, parce que c'est important
20
21!> **FAITES ATTENTION A UTILISER LA BONNE VERSION !**
22
23Si votre clavier est annoncé comme fonctionnant grâce à QMK mais n'est pas dans la liste, il y a des chances que le développeur ne l'ait pas encore fait, ou que nous n'avons pas encore eu le temps de le merger. Ajoutez un problème (issue) sur [qmk_firmware](https://github.com/qmk/qmk_firmware/issues) demandant le support de votre clavier, s'il n'y a pas de [Pull Request](https://github.com/qmk/qmk_firmware/pulls?q=is%3Aopen+is%3Apr+label%3Akeyboard) ouvert pour lui. Il y a aussi des claviers alimentés par QMK qui sont sur le compte GitHub du fabricant, il est bon de le vérifier aussi.
24
25## Sélectionner la disposition de votre clavier
26
27Choisissez la disposition (layout) qui représente le mieux la keymap que vous voulez créer. Certains claviers n'ont pas encore assez de dispositions ou des dispositions incorrectes. Ils seront supportés dans le future.
28
29## Nom de la Keymap
30
31Appelez cette keymap comme vous voulez.
32
33?> Si vous rencontrez des problèmes lors de la compilation, il peut être utile de changer ce nom, il peut déjà exister dans le dépôt du firmware QMK.
34
35## Créer votre keymap
36
37Entrer un keycode peut s'accomplir de 3 façons différentes.
38
391. Glisser déposer
402. Cliquer sur un endroit vide sur le layout et cliquer sur le keycode souhaité
413. Cliquer sur un endroit vide sur le layout et appuyer sur une touche physique de votre clavier.
42
43Passez votre souris au dessus d'une touche et un affichage vous dira quel est le rôle du keycode. Pour une version plus verbeuse suivre:
44
45[Référence Keycode basique](https://docs.qmk.fm/#/keycodes_basic)
46[Référence Keycode avancé](https://docs.qmk.fm/#/feature_advanced_keycodes)
47
48Dans le cas où vous ne trouvez pas une disposition qui supporte votre keymap, par exemple trois places pour une barre d'espace, ou deux places pour retour clavier, ou deux places pour shift, etc. etc. remplissez les TOUTES.
49
50### Exemples
51
523 places pour la barre d'espace: Remplissez les TOUTES avec la barre d'espace
53
542 places pour un retour clavier: Remplissez les DEUX avec un retour clavier
55
562 places pour un shift droit: Remplissez les DEUX avec un shift droit
57
581 place pour un shift gauche et 1 place pour le support ISO: Remplissez les deux avec un shift gauche
59
605 places, mais seulement 4 touches: Deviner et vérifier, ou demander à quelqu'un qui l'a déjà fait.
61
62## Sauvez votre keymap pour des éditions futures
63
64Une fois satisfait de votre keymap, ou si vous souhaitez revenir travailler dessus plus tard, appuyez sur le bouton `Export Keymap`. Il vous permettra de sauvegarder votre keymap avec le nom choisi au dessus suivi de .json.
65
66Vous pouvez ensuite charger ce fichier .json à nouveau en appuxant sur le bouton `Import Keymap`.
67
68!> **ATTENTION** Ce n'est pas le même type de fichier .json utilisé pour kbfirmware.com ou n'importe quel autre outil. Si vous essayez d'utiliser ce fichier pour d'autres outil, ou le fichier .json d'autres outils avec le configurateur QMK, il y a des chances que votre clavier **explose**.
69
70## Générer votre fichier firmware
71
72Appuyez sur le bouton `Compile`.
73
74Une fois la compilation terminée, vous pourrez appuyer sur le bouton vert `Download Firmware`.
75
76## Ecrire votre firmware sur votre clavier
77
78Merci de vous référer à [Flasher le Firmware](fr-FR/newbs_flashing.md)
79
80## Dépannage
81
82#### Mon fichier json ne fonctionne pas
83
84Si le fichier .json a été généré par le configurateur QMK, bravo vous avez trouvé un bug. Merci d'ouvrir une issue sur [qmk_configurator](https://github.com/qmk/qmk_configurator/issues)
85
86Sinon... vous avez raté mon message écris en gras qui dit de ne pas utiliser d'autres fichiers .json?
87
88#### Il y a des espaces en trop dans mon alyout? Qu'est-ce que je fais?
89
90Si vous voulez dire que vous avez trois places pour une barre d'espace, le mieux est de les remplir tous avec une barre d'espace. Vous pouvez faire de même avec les retour clavier et les shift.
91
92#### C'est quoi le keycode pour .......
93
94Merci de regarder
95
96[Référence keycode basique](https://docs.qmk.fm/#/keycodes_basic)
97[Référence keycode avancé](https://docs.qmk.fm/#/feature_advanced_keycodes)
98
99#### Ca ne compile pas?
100
101Merci de vérifier les autres dispositions de votre keymap afin d'être sûr qu'il n'y a pas de touches aléatoires.
102
103## Problèmes et Bugs
104
105Nous acceptons toujours les demandes des clients et les rapports de bugs. Merci de les remplirs sur [qmk_configurator](https://github.com/qmk/qmk_configurator/issues)
diff --git a/docs/fr-fr/newbs_flashing.md b/docs/fr-fr/newbs_flashing.md
deleted file mode 100644
index f1f6b1131..000000000
--- a/docs/fr-fr/newbs_flashing.md
+++ /dev/null
@@ -1,367 +0,0 @@
1# Flasher votre clavier
2
3Maintenant que vous avez compilé un firmware custom, vous allez vouloir le flasher dans votre clavier.
4
5## Flasher votre clavier avec QMK Toolbox
6
7La manière la plus simple de flasher votre clavier est avec [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases).
8
9Toutefois, la QMK Toolbox n'est actuellement disponible que pour Windows et macOS. Si vous utilisez Linux (ou préférez flasher le firmware depuis la ligne de commande), vous devrez utiliser [la métode décrite ci-dessous](newbs_flashing.md#flash-your-keyboard-from-the-command-line).
10
11### Charger le fichier dans QMK Toolbox
12
13Démarrez en ouvrant l'application QMK Toolbox. Cherchez le fichier de firmware dans Finder ou Explorer. Vore firmware de clavier peut être dans un de deux formats `.hex` ou `.bin`. QMK essaye de copier le bon format pour votre clavier du répertoire racine `qmk_firmware`.
14
15?> Si vous êtes sous Windows ou macOS il y a des commandes que vous pouvez utiliser pour facilement ouvrir le répertoire firmware dans Explorer ou Finder.
16
17?> Windows:
18
19 start .
20
21?> macOS:
22
23 open .
24
25Le fichier firmware suit toujours ce format de nommage:
26
27 <keyboard_name>_<keymap_name>.{bin,hex}
28
29Par exemple, le `plank/rev5` avec une keymap `default` aura ce nom de fichier:
30
31 planck_rev5_default.hex
32
33Une fois que vous aurez trouvé votre fichier de firmware, glissez le dans la boîte "Local file" sur QMK Toolbox, ou cliquez sur "Open" et naviguez où votre firmware est enregistré.
34
35### Mettez votre clavier en mode DFU (Bootloader)
36
37Afin de flasher votre firmware custom, vous devez mettre votre clavier dans un mode spécial. Lorsqu'il sera dans ce mode, vous ne pourrez pas taper ou utiliser votre clavier. Il est très important que vous ne débranchiez pas votre clavier ou n'arrêtiez pas le processus d'écriture du firmware.
38
39Chaque clavier a une manière différente d'entrer dans ce mode spécial. Si votre clavier tourne actuellement QMK ou TMK et vous n'avez pas reçu d'instruction spécifiques, essayez, dans cet ordre:
40
41* Enfoncez les deux touches shift et appuyez sur `Pause`
42* Enfoncez les deux touches shift et appuyez sur `B`
43* Débranchez votre clavier, gardez shift la barre d'espace et `B` en même temps, branchez votre clavier et attendez une seconde avant de relâcher les touches.
44* Appuyez la touche physique `RESET` en bas du PCB
45* Trouvez les pins sur le PCB marquées `BOOT0` ou `RESET`, court circuitez ces pins en branchant votre PCB
46
47Lorsque vous aurez réussi, vous verrez le message suivant dans QMK Toolbox:
48
49```
50*** Clueboard - Clueboard 66% HotSwap disconnected -- 0xC1ED:0x2390
51*** DFU device connected
52```
53
54### Flasher votre clavier
55
56Appuyez sur le boutton `Flash` dans QMK Toolbox. Vous verrez un résultat similaire à ce qui suit:
57
58```
59*** Clueboard - Clueboard 66% HotSwap disconnected -- 0xC1ED:0x2390
60*** DFU device connected
61*** Attempting to flash, please don't remove device
62>>> dfu-programmer atmega32u4 erase --force
63 Erasing flash... Success
64 Checking memory from 0x0 to 0x6FFF... Empty.
65>>> dfu-programmer atmega32u4 flash /Users/skully/qmk_firmware/clueboard_66_hotswap_gen1_skully.hex
66 Checking memory from 0x0 to 0x55FF... Empty.
67 0% 100% Programming 0x5600 bytes...
68 [>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>] Success
69 0% 100% Reading 0x7000 bytes...
70 [>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>] Success
71 Validating... Success
72 0x5600 bytes written into 0x7000 bytes memory (76.79%).
73>>> dfu-programmer atmega32u4 reset
74
75*** DFU device disconnected
76*** Clueboard - Clueboard 66% HotSwap connected -- 0xC1ED:0x2390
77```
78
79## Flashez votre clavier à l'aide de la ligne de commande
80
81C'est désormais relativement simple. Lorsque vous êtes prêt à compiler et à flasher votre firmware, ouvrez la fenêtre de votre terminal et exécutez la commande de build :
82
83 make <my_keyboard>:<my_keymap>:flash
84
85Par exemple, si votre keymap s'appelle "xyverz" et que vous fabriquez une keymap pour un clavier `planck` de version `rev5` vous devrez utiliser cette commande:
86
87 make planck/rev5:xyverz:flash
88
89La commande va vérifier la configuration du clavier, puis tentera de le flasher en fonction du bootloader (chargeur d’amorçage) spécifié. Cela signifie que vous n'avez pas besoin de savoir quel bootloader votre clavier utilise. Exécutez simplement la commande et laissez-le faire le gros du travail.
90
91Cependant, tout dépend du bootloader qui est installé sur le clavier. Si cette information n’est pas configurée ou si vous tentez de flasher un clavier qui ne permet pas d’être flashé alors vous obtiendrez cette erreur:
92
93 WARNING: This board's bootloader is not specified or is not supported by the ":flash" target at this time.
94
95Dans ce cas, vous devrez choisir le bootloader.
96
97Il y a cinq bootloaders principaux. Les Pro-Micro et les clones utilisent Caterina, les Teensy utilisent Halfkay, les claviers AVR d’OLKB utilisent QMK-DFU, certains controleurs atmega32u4 utilisent DFU et la plupart des controlleurs ARM utilisent ARM DFU.
98
99Vous pouvez trouver plus d'information à propos des bootloaders sur la page [Instructions de flash et information sur le Bootloader](flashing.md).
100
101Si vous savez quel bootloader vous utilisez, lorsque vous compilez le firmware, vous pouvez ajouter quelques options à la commande `make` pour automatiser le processus de flash.
102
103### DFU
104
105Pour le bootloader DFU, lorsque vous êtes prêts à compiler et flasher votre firmware, ouvrez votre fenêtre de terminal et lancez la commande de compilation:
106
107 make <my_keyboard>:<my_keymap>:dfu
108
109Par exemple, si vous keymap s'appelle "xyverz" et vous compilez une keymap pour une plank rev5, vous utiliserez cette commande:
110
111 make planck/rev5:xyverz:dfu
112
113Une fois la compilation terminée, le résultat devrait être le suivant:
114
115```
116Linking: .build/planck_rev5_xyverz.elf [OK]
117Creating load file for flashing: .build/planck_rev5_xyverz.hex [OK]
118Copying planck_rev5_xyverz.hex to qmk_firmware folder [OK]
119Checking file size of planck_rev5_xyverz.hex
120 * File size is fine - 18574/28672
121 ```
122
123Une fois arrivé à ce stade, le script de compilation va chercher le bootloader DFU toutes les 5 secondes. Il va répéter les messages suivants jusqu'à ce que l'appareil soit trouvé ou que vous l'annuliez.
124
125 dfu-programmer: no device present.
126 Error: Bootloader not found. Trying again in 5s.
127
128Une fois terminé, vous devrez mettre à zéro le contrôleur. Vous allez voir un résultat similaire à ceci:
129
130```
131*** Attempting to flash, please don't remove device
132>>> dfu-programmer atmega32u4 erase --force
133 Erasing flash... Success
134 Checking memory from 0x0 to 0x6FFF... Empty.
135>>> dfu-programmer atmega32u4 flash /Users/skully/qmk_firmware/clueboard_66_hotswap_gen1_skully.hex
136 Checking memory from 0x0 to 0x55FF... Empty.
137 0% 100% Programming 0x5600 bytes...
138 [>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>] Success
139 0% 100% Reading 0x7000 bytes...
140 [>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>] Success
141 Validating... Success
142 0x5600 bytes written into 0x7000 bytes memory (76.79%).
143>>> dfu-programmer atmega32u4 reset
144```
145
146?> Si vous avez des soucis concernant ceci - par exemple `dfu-programmer: no device present` - merci de regarder [Foires Aux Questions de Compilation](faq_build.md).
147
148#### Commandes DFU
149
150Il y aun certain nombre de commandes du DFU que vous pouvez utiliser pour flasher un firmware sur un device DFU:
151
152* `:dfu` - C'est l'option standard qui attends jusqu'à e qu'un appareil DFU soit disponible, puis flash le firmware. Il va vérifier toutes les 5 secondes, afin de voir si un appareil DFU est apparu.
153* `:dfu-ee` - Ceci flash un fichier `eep` à la place du standard hex, peu commun.
154* `:dfu-split-left` - Ceci flash le firmware standard, comme la commande standard (`:dfu`). Toutefois, elle flash aussi les fichiers EEPROM du "côté gauche" pour les claviers scindés. _C'est l'option idéale pour les claviers scindés basés sur Elite C._
155* `:dfu-split-right` - Ceci flash le firmware standard, comme la commande standard (`:dfu`). Toutefois, elle flash aussi les fichiers EEPROM du "côté droit" pour les claviers scindés. _C'est l'option idéale pour les claviers scindés basés sur Elite C._
156
157### Caterina
158
159Pour les boards Arduino et leurs clones (tel que le SparkFun ProMicro), lorsque vous êtes prêt à compiler et flasher votre firmware, ouvrez votre terminal et lancer la commande de compilation:
160
161 make <my_keyboard>:<my_keymap>:avrdude
162
163Par exemple, si votre keymap se nomme "xyverz" et que vous compilez une keymap pour un Lets Split rev2, vous utiliserez la commande suivante:
164
165 make lets_split/rev2:xyverz:avrdude
166
167Une fois le firmware compilé, vous aurez le résultat suivant:
168
169```
170Linking: .build/lets_split_rev2_xyverz.elf [OK]
171Creating load file for flashing: .build/lets_split_rev2_xyverz.hex [OK]
172Checking file size of lets_split_rev2_xyverz.hex [OK]
173 * File size is fine - 27938/28672
174Detecting USB port, reset your controller now..............
175```
176
177Une fois ceci fait, réinitialisez votre board et le script va détecter et flasher le firmware. La sortie devrait ressembler à quelque chose comme ça:
178
179```
180Detected controller on USB port at /dev/ttyS15
181
182Connecting to programmer: .
183Found programmer: Id = "CATERIN"; type = S
184 Software Version = 1.0; No Hardware Version given.
185Programmer supports auto addr increment.
186Programmer supports buffered memory access with buffersize=128 bytes.
187
188Programmer supports the following devices:
189 Device code: 0x44
190
191avrdude.exe: AVR device initialized and ready to accept instructions
192
193Reading | ################################################## | 100% 0.00s
194
195avrdude.exe: Device signature = 0x1e9587 (probably m32u4)
196avrdude.exe: NOTE: "flash" memory has been specified, an erase cycle will be performed
197 To disable this feature, specify the -D option.
198avrdude.exe: erasing chip
199avrdude.exe: reading input file "./.build/lets_split_rev2_xyverz.hex"
200avrdude.exe: input file ./.build/lets_split_rev2_xyverz.hex auto detected as Intel Hex
201avrdude.exe: writing flash (27938 bytes):
202
203Writing | ################################################## | 100% 2.40s
204
205avrdude.exe: 27938 bytes of flash written
206avrdude.exe: verifying flash memory against ./.build/lets_split_rev2_xyverz.hex:
207avrdude.exe: load data flash data from input file ./.build/lets_split_rev2_xyverz.hex:
208avrdude.exe: input file ./.build/lets_split_rev2_xyverz.hex auto detected as Intel Hex
209avrdude.exe: input file ./.build/lets_split_rev2_xyverz.hex contains 27938 bytes
210avrdude.exe: reading on-chip flash data:
211
212Reading | ################################################## | 100% 0.43s
213
214avrdude.exe: verifying ...
215avrdude.exe: 27938 bytes of flash verified
216
217avrdude.exe: safemode: Fuses OK (E:CB, H:D8, L:FF)
218
219avrdude.exe done. Thank you.
220```
221
222Si vous avez un souci, essayez de faire ceci:
223
224 sudo make <my_keyboard>:<my_keymap>:avrdude
225
226#### Commandes Caterina
227
228Il existe un certain nombre de commandes DFU que vous pouvez utiliser pour mettre à jour le firmware sur un périphérique DFU:
229
230* `: avrdude` - Il s’agit de l’option normale. Elle attend qu’un appareil Caterina soit disponible, puis tente de flasher le firmware. Il attendra de détecter un autre port COM, puis il flashera à nouveau.
231* `: 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_
232* `: 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.
233* `: 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.
234
235### HalfKay
236
237Pour les composants PJRC (les Teensy), lorsque vous êtes prêts à compiler et flasher votre firmware, ouvrez votre fenêtre de terminal et lancez la commande de compilation suivante:
238
239 make <my_keyboard>:<my_keymap>:teensy
240
241Par exemple, si vous keymap s'appelle "xyverz" et vous compilez une keymap pour un Ergodox ou un Ergodox EZ, vous utiliserez cette commande:
242
243 make ergodox_ez:xyverz:teensy
244
245Une fois la compilation du firmware terminée, votre sortie devrait ressembler à ça:
246
247```
248Linking: .build/ergodox_ez_xyverz.elf [OK]
249Creating load file for flashing: .build/ergodox_ez_xyverz.hex [OK]
250Checking file size of ergodox_ez_xyverz.hex [OK]
251 * File size is fine - 25584/32256
252 Teensy Loader, Command Line, Version 2.1
253Read "./.build/ergodox_ez_xyverz.hex": 25584 bytes, 79.3% usage
254Waiting for Teensy device...
255 (hint: press the reset button)
256 ```
257
258Une fois terminé, réinitialisez votre board. Une fois fait, vous verrez une sortie comme ça:
259
260 ```
261 Found HalfKay Bootloader
262Read "./.build/ergodox_ez_xyverz.hex": 28532 bytes, 88.5% usage
263Programming............................................................................................................................................................................
264...................................................
265Booting
266```
267
268### STM32 (ARM)
269
270Pour la majorité des boards ARM (incluant les Proton C, Planck Rev 6, et Preonic Rev 3), lorsque vous êtes prêt à compiler et flasher votre firmware, ouvrez la fenêtre de terminal et lancez la commande de compilation:
271
272 make <my_keyboard>:<my_keymap>:dfu-util
273
274Par exemple, si votre keymap s'appelle "xyverz" et vous compilez une keymap pour le clavier Plank Revision 6, vous utiliserez cette commande et redémarrerez le clavier vers le bootloader (avant que la compilation soit terminée):
275
276 make planck/rev6:xyverz:dfu-util
277
278Une fois le firmware compilé, il va afficher quelque chose comme ça:
279
280```
281Linking: .build/planck_rev6_xyverz.elf [OK]
282Creating binary load file for flashing: .build/planck_rev6_xyverz.bin [OK]
283Creating load file for flashing: .build/planck_rev6_xyverz.hex [OK]
284
285Size after:
286 text data bss dec hex filename
287 0 41820 0 41820 a35c .build/planck_rev6_xyverz.hex
288
289Copying planck_rev6_xyverz.bin to qmk_firmware folder [OK]
290dfu-util 0.9
291
292Copyright 2005-2009 Weston Schmidt, Harald Welte and OpenMoko Inc.
293Copyright 2010-2016 Tormod Volden and Stefan Schmidt
294This program is Free Software and has ABSOLUTELY NO WARRANTY
295Please report bugs to http://sourceforge.net/p/dfu-util/tickets/
296
297Invalid DFU suffix signature
298A valid DFU suffix will be required in a future dfu-util release!!!
299Opening DFU capable USB device...
300ID 0483:df11
301Run-time device DFU version 011a
302Claiming USB DFU Interface...
303Setting Alternate Setting #0 ...
304Determining device status: state = dfuERROR, status = 10
305dfuERROR, clearing status
306Determining device status: state = dfuIDLE, status = 0
307dfuIDLE, continuing
308DFU mode device DFU version 011a
309Device returned transfer size 2048
310DfuSe interface name: "Internal Flash "
311Downloading to address = 0x08000000, size = 41824
312Download [=========================] 100% 41824 bytes
313Download done.
314File downloaded successfully
315Transitioning to dfuMANIFEST state
316```
317
318#### Commandes STM32
319
320Il y aun certain nombre de commandes du DFU que vous pouvez utiliser pour flasher un firmware sur un device STM32:
321
322* `:dfu-util` - C'est l'option standard pour flasher un appareil STM32. Elle attendra qu'un bootloader STM32 soit présent et tentera de l’utiliser.
323* `:dfu-util-left` - Ceci flasher le firmware standard, comme la commande standard (`:dfu-util`). Toutefois, elle flasher aussi les fichiers EEPROM du "côté gauche" pour les claviers scindés.
324* `:dfu-util-right` - Ceci flash le firmware standard, comme la commande standard (`:dfu-util`). Toutefois, elle flash aussi les fichiers EEPROM du "côté droit" pour les claviers scindés.
325* `: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.
326
327### BootloadHID
328
329Pour les claviers basés sur Bootmapper Client(BMC)/bootloadHID/ATmega32A, si vous êtes prêts à compiler et flasher le firmware, ouvrez votre fenêtre de terminal et lancez la commande suivante:
330
331 make <my_keyboard>:<my_keymap>:bootloaderHID
332
333Par exemple, si votre keymap s'appelle "xyverz" et que vous compilez une keymap pour un jj40, utilisez cette commande:
334
335 make jj40:xyverz:bootloaderHID
336
337Une fois le firmware compilé, vous aurez cette sortie:
338
339```
340Linking: .build/jj40_default.elf [OK]
341Creating load file for flashing: .build/jj40_default.hex [OK]
342Copying jj40_default.hex to qmk_firmware folder [OK]
343Checking file size of jj40_default.hex [OK]
344 * The firmware size is fine - 21920/28672 (6752 bytes free)
345```
346
347A ce stade, le script de build va chercher le bootloader DFU toutes les 5 secondes. Il répétera l ’affichage de ce message jusqu'à ce que l’appareil soit trouvé ou que vous annuliez l'opération```
348
349```
350Error opening HIDBoot device: The specified device was not found
351Trying again in 5s.
352```
353
354Une fois ce résultat obtenu, réinitialisez le contrôleur. Le résultat suivant devrait s’afficher:
355
356```
357Page size = 128 (0x80)
358Device size = 32768 (0x8000); 30720 bytes remaining
359Uploading 22016 (0x5600) bytes starting at 0 (0x0)
3600x05580 ... 0x05600
361```
362
363## Faites l'essai!
364
365Bravo! Votre firmware customisé a été programmé sur votre clavier!
366
367Essayez-le et vérifiez qu'il fonctionne comme vous le souhaitez. Nous avons écrit [Tester et débugger](newbs_testing_debugging.md) pour compléter le guide du débutant, alors allez voir là-bas pour apprendre comment dépanner vos fonctionnalités custom.
diff --git a/docs/fr-fr/newbs_getting_started.md b/docs/fr-fr/newbs_getting_started.md
deleted file mode 100644
index 1a5740185..000000000
--- a/docs/fr-fr/newbs_getting_started.md
+++ /dev/null
@@ -1,101 +0,0 @@
1# Introduction
2
3Votre clavier d'ordinateur contient un processeur, proche de celui dans votre ordinateur. Ce processeur exécute un logiciel responsable de détecter les touches appuyées et envoie des rapports à propos de l'état du clavier lorsque les touches sont appuyées et relâchées. QMK prend le rôle de ce logiciel, détectant les appuis des boutons et passant cette information à l'ordinateur hôte. Lorsque vous construisez votre keymap customisée, vous créez l'équivalent d'un programme exécutable pour votre clavier.
4
5QMK essaie de rendre les choses simples faciles, et les choses difficiles possibles. Vous n'avez pas à savoir programmer pour créer des keymaps puissantes - vous devez seulement suivre quelques règles de syntaxe simples.
6
7# Guide de démarrage
8
9Avant de pouvoir construire des keymaps, vous devez installer quelques logiciels et configurer votre environnement de compilation. Ceci n'a besoin d'être fait seulement une fois, peu importe le nombre de clavier pour lesquels vous compter compiler un firmware.
10
11Si vous préférez une approche plus proche d'une interface graphique, considérez utiliser l'outil en ligne [QMK Configurator](https://config.qmk.fm). Référez-vous à [Construire votre premier firmware en utilisant l'interface graphique en ligne](newbs_building_firmware_configurator.md).
12
13## Logiciels à télécharger
14
15### Editeur de texte
16
17Vous allez avoir besoin d'un programme qui peut éditer et sauvegarder des fichiers **plain text**. Si vous êtes sur Windows, vous pouvez utiliser notepad et sur Linux vous pouvez utiliser gedit. Ces deux options sont des éditeurs de texte simples mais fonctionnels. Sur macOS, faites attention avec l'application par défaut TextEdit: elle ne sauvegardera pas les fichiers en mode "plain text" sauf si vous sélectionnez explicitement _Make Plain Text_ à partir du menu _Format_.
18
19Vous pouvez aussi télécharger et installer un éditeur de texte dédié comme [Sublime Text](https://www.sublimetext.com/) ou [VS Code](https://code.visualstudio.com/). C'est probablement la meilleure solution peu importe la plateforme car ce sont des programmes conçus spécifiquement pour éditer du code.
20
21?> Pas sûr de quel éditeur de texte utiliser? Laurence Bradford a écrit une [excellente introduction](https://learntocodewith.me/programming/basics/text-editors/) au sujet.
22
23### QMK Toolbox
24
25QMK Toolbox est un programme graphique optionnel pour Windows et macOS qui permet à la fois de programmer et débugger votre clavier customisé. Il vous sera probablement très utile pour facilement flasher votre clavier et analyser ses messages de débugage.
26
27[Télécharger la dernière version ici.](https://github.com/qmk/qmk_toolbox/releases/latest)
28
29* Pour Windows: `qmk_toolbox.exe` (portable) or `qmk_toolbox_install.exe` (installeur)
30* Pour macOS: `QMK.Toolbox.app.zip` (portable) or `QMK.Toolbox.pkg` (installeur)
31
32## Configurez votre environnement
33
34Nous avons essayé de rendre QMK aussi simple que possible à configurer. Vous avez uniquement à préparer votre environnment Linux ou Unix et laisser QMK installer le reste.
35
36?> Si vous n'avez jamais travaillé avec la ligne de commande Linux/Unix, il y a un certain nombre de concepts basiques et de commandes que vous devriez apprendre. Ces ressources vous apprendrons suffisemment pour travailler avec QMK:<br>
37[Commandes Linux à savoir](https://www.guru99.com/must-know-linux-commands.html)<br>
38[Commandes Unix de base](https://www.tjhsst.edu/~dhyatt/superap/unixcmd.html)
39
40### Windows
41
42Vous devez installer MSYS2 et Git.
43
44* Suivez les instructions d'installation sur la [page de MSYS2](https://www.msys2.org).
45* Fermez tous les terminaux MSYS2 éventuellement ouverts et ouvrez un nouveau terminal MSYS2 MinGW 64-bit.
46* Installez Git en lançant la commande: `pacman -S git`.
47
48### macOS
49
50Vous devez installer Homebew. Suivez les instructions sur la [page de Homebrew](https://brew.sh).
51
52Une fois Homebrew installé, continuez avec _Configurer QMK_. Dans cette étape, nous lancerons un script qui va installer d'autres paquets.
53
54### Linux
55
56Vous devez installer Git. Il est très probable que vous l'ayez déjà installé, mais sinon, une des commandes suivantes devrait l'installer:
57
58* Debian / Ubuntu / Devuan: `apt-get install git`
59* Fedora / Red Hat / CentOS: `yum install git`
60* Arch: `pacman -S git`
61
62?> Docker est aussi une option sur toutes les plateformes. [Appuyez ici pour plus de détail.](getting_started_build_tools.md#docker)
63
64## Configurer QMK
65
66Une fois votre environnement Linux/Unix configuré, vous êtes prêt à télécharger QMK. Nous allons le faire en utilisant Git pour "cloner" le dépôt de QMK. Ouvrez un terminal ou une fenêtre MSYS2 MinGW et gardez le ouvert pour le reste de ce guide. Dans ce terminal, lancez ces deux commandes:
67
68```shell
69git clone --recurse-submodules https://github.com/qmk/qmk_firmware.git
70cd qmk_firmware
71```
72
73?> Si vous savez déjà [comment utiliser GitHub](getting_started_github.md), nous recommandons que vous créez et clonez votre propre fork. Si vous ne savez pas ce que cela veut dire, vous pouvez sans problème ignorer ce message.
74
75QMK vient avec un script pour vous aider à configurer le reste de ce que vous aurez besoin. Vous devez le lancer en tapant la ligne de commande suivante:
76
77 util/qmk_install.sh
78
79## Testez votre environnement de compilation
80
81Maintenant que votre environnement de compilation de QMK est configuré, vous pouvez compiler un firmware pour votre clavier. Démarrez en compilant la keymap par défaut du clavier. Vous devriez pouvoir le faire avec une commande de ce format:
82
83 make <keyboard>:default
84
85Par exemple, pour compiler un firmware pour une Clueboard 66%, vous utiliserez:
86
87 make clueboard/66/rev3:default
88
89Une fois ceci fait, vous devriez avoir beaucoup d'information dans votre sortie qui devrait se terminer par quelque chose de similaire à ça:
90
91```
92Linking: .build/clueboard_66_rev3_default.elf [OK]
93Creating load file for flashing: .build/clueboard_66_rev3_default.hex [OK]
94Copying clueboard_66_rev3_default.hex to qmk_firmware folder [OK]
95Checking file size of clueboard_66_rev3_default.hex [OK]
96 * The firmware size is fine - 26356/28672 (2316 bytes free)
97```
98
99# Créer votre Keymap
100
101Vous êtes maintenant prêt à créer votre propre keymap! Passez à l'étape [Compiler votre premier firmware](newbs_building_firmware.md) pour ce faire.
diff --git a/docs/fr-fr/newbs_learn_more_resources.md b/docs/fr-fr/newbs_learn_more_resources.md
deleted file mode 100644
index 01b1c9e8e..000000000
--- a/docs/fr-fr/newbs_learn_more_resources.md
+++ /dev/null
@@ -1,14 +0,0 @@
1# Ressources d'apprentissage
2
3Ces ressources permettent de donner aux nouveaux membres de la communauté QMK plus de compréhension aux informations données dans la documentation Newbs.
4
5Ressources Git:
6
7* [Tutoriel général](https://www.codecademy.com/learn/learn-git)
8* [Jeu Git pour apprendre avec des exemples](https://learngitbranching.js.org/)
9* [Des ressources Git pour en savoir plus à propos de GitHub](getting_started_github.md)
10* [Des ressources Git spécifiques à QMK](contributing.md)
11
12Ressources sur les lignes de commande:
13
14* [Bon tutoriel général sur la ligne de commande](https://www.codecademy.com/learn/learn-the-command-line)
diff --git a/docs/fr-fr/newbs_testing_debugging.md b/docs/fr-fr/newbs_testing_debugging.md
deleted file mode 100644
index 85a7fb9f1..000000000
--- a/docs/fr-fr/newbs_testing_debugging.md
+++ /dev/null
@@ -1,104 +0,0 @@
1# Test et débugage
2
3Une fois votre clavier configuré avec un firmware custom, vous êtes prêt à le tester. Avec un peu de chance, tout fonctionne parfaitement bien, dans le cas contraire, ce document vous aidera à trouver où se trouve le problème.
4
5## Tester
6
7Tester votre clavier est normalement assez simple. Appuyez chaque touche de votre clavier et assurez-vous qu'il envoie les touches auquel vous vous attendiez. Il existe même des programmes qui vous aideront à vérifier qu'aucune touche ne soit oubliée.
8
9Note: ces programmes ne sont ni fournis ni approuvés par QMK.
10
11* [QMK Configurator](https://config.qmk.fm/#/test/) (Web)
12* [Switch Hitter](https://web.archive.org/web/20190413233743/https://elitekeyboards.com/switchhitter.php) (Windows seulement)
13* [Keyboard Viewer](https://www.imore.com/how-use-keyboard-viewer-your-mac) (Mac seulement)
14* [Keyboard Tester](https://www.keyboardtester.com) (Web)
15* [Keyboard Checker](https://keyboardchecker.com) (Web)
16
17## Débuguer
18
19Votre clavier va envoyer des informations de débugage si vous avez `CONSOLE_ENABLE = yes` dans votre fichier `rules.mk`. Par défaut, la sortie est très limitée, mais vous pouvez activer le mode debug pour augmenter la quantité de sortie de débugage. Utilisez le keycode `DEBUG` dans votre keymap, utilisez la fonction [Commande](feature_command.md) pour activer le mode debug ou ajoutez le code suivant à votre keymap.
20
21```c
22void keyboard_post_init_user(void) {
23 // Customise these values to desired behaviour
24 debug_enable=true;
25 debug_matrix=true;
26 //debug_keyboard=true;
27 //debug_mouse=true;
28}
29```
30
31### Débuguer avec QMK Toolbox
32
33Pour les plateformes compatibles, [QMK Toolbox](https://github.com/qmk/qmk_toolbox) peut être utilisé pour afficher les messages de débugage pour votre clavier.
34
35### Débuguer avec hid_listen
36
37Vous préférez une solution basée sur le terminal? [hid_listen](https://www.pjrc.com/teensy/hid_listen.html), fourni par PJRC, peut aussi être utilisé pour afficher des messages de débugage. Des versions compilées pour Windows, Linux et MacOS sont disponibles.
38
39<!-- FIXME: Describe the debugging messages here. -->
40
41## Envoyer vos propres messages de débugage
42
43Parfois, il est utile d'afficher des messages de débugage depuis votre [code custom](custom_quantum_functions.md). Le faire est assez simple. Commencez par ajouter `print.h` au début de votre fichier:
44
45```c
46#include "print.h"
47```
48
49Une fois fait, vous pouvez utiliser les fonctions print suivantes:
50
51* `print("string")`: Affiche une simple chaîne de caractères.
52* `uprintf("%s string", var)`: Affiche une chaîne de caractères formatée.
53* `dprint("string")` Affiche une chaîne de caractère simple, mais uniquement lorsque le mode debug est activé.
54* `dprintf("%s string", var)`: Affiche une chaîne de caractère formatée, mais uniquement lorsque le mode debug est activé.
55
56## Exemples de debugage
57
58Si dessous se trouve une liste d'exemples réels de débugage. Pour plus d'information, référez-vous à [Débuguer/Dépanner QMK](faq_debug.md).
59
60### A quelle position de la matrice se trouve cette activation de touche?
61
62Lors du portage ou lorsque vous essayez de diagnostiquer un problème de PCB, il est utile de savoir si une activation de touche est enregistrée correctement. Pour activer le log de ce scénario, ajoutez le code suivant à votre fichier keymaps `keymap.c`.
63
64```c
65bool process_record_user(uint16_t keycode, keyrecord_t *record) {
66 // If console is enabled, it will print the matrix position and status of each key pressed
67#ifdef CONSOLE_ENABLE
68 uprintf("KL: kc: %u, col: %u, row: %u, pressed: %u\n", keycode, record->event.key.col, record->event.key.row, record->event.pressed);
69#endif
70 return true;
71}
72```
73
74Exemple de sortie
75
76```text
77Waiting for device:.......
78Listening:
79KL: kc: 169, col: 0, row: 0, pressed: 1
80KL: kc: 169, col: 0, row: 0, pressed: 0
81KL: kc: 174, col: 1, row: 0, pressed: 1
82KL: kc: 174, col: 1, row: 0, pressed: 0
83KL: kc: 172, col: 2, row: 0, pressed: 1
84KL: kc: 172, col: 2, row: 0, pressed: 0
85```
86
87### Combien de temps cela a pris pour une activation de touche?
88
89Lorsque vous testez des problèmes de performance, il peut être utile de savoir à quelle fréquence la matrice est scannée. Pour activer le log dans ce scénario, ajoutez la ligne suivante à votre fichier `config.h` de votre keymaps.
90
91```c
92#define DEBUG_MATRIX_SCAN_RATE
93```
94
95Exemple de sortie
96
97```text
98 > matrix scan frequency: 315
99 > matrix scan frequency: 313
100 > matrix scan frequency: 316
101 > matrix scan frequency: 316
102 > matrix scan frequency: 316
103 > matrix scan frequency: 316
104```
diff --git a/docs/he-il/README.md b/docs/he-il/README.md
deleted file mode 100644
index 5c113eb49..000000000
--- a/docs/he-il/README.md
+++ /dev/null
@@ -1,33 +0,0 @@
1<div dir="rtl" markdown="1">
2# קושחה עבור Quantum Mechanical Keyboard
3
4[![גירסה נוכחית](https://img.shields.io/github/tag/qmk/qmk_firmware.svg)](https://github.com/qmk/qmk_firmware/tags)
5[![ערוץ דיסקורד](https://img.shields.io/discord/440868230475677696.svg)](https://discord.gg/Uq7gcHh)
6[![מצב מסמכים](https://img.shields.io/badge/docs-ready-orange.svg)](https://docs.qmk.fm)
7[![תומכי GitHub](https://img.shields.io/github/contributors/qmk/qmk_firmware.svg)](https://github.com/qmk/qmk_firmware/pulse/monthly)
8[![מזלגות GitHub](https://img.shields.io/github/forks/qmk/qmk_firmware.svg?style=social&label=Fork)](https://github.com/qmk/qmk_firmware/)
9
10## מה היא קושחת QMK?
11
12QMK (*Quantum Mechanical Keyboard*) היא קהילת קוד פתוח (open source) שמתחזקת את קושחת QMK, QMK Toolbox, qmk.fm, והמסמכים המתאימים. קושחת QMK היא קושחה עבור מקלדות המבוססת על [tmk\_keyboard](https://github.com/tmk/tmk_keyboard) עם כמה תוספות עבור בקרי Atmel AVR ובאופן ספציפי יותר - [מוצרי OLKB](https://olkb.com), מקלדת [ErgoDox EZ](https://www.ergodox-ez.com), וגם [מוצרי Clueboard](https://clueboard.co/). בנוסף, הקושחה עברה פורט עבור שבבי ARM באמצעות ChibiOS. ניתן להשתמש בה על מנת להפעיל את מקלדות ה PCB המקוסטמות שלך.
13
14## איך להשיג אותה
15
16אם אתם מתכננים לתרום מיפוי מקשים, מקלדת או יכולת ל QMK, הדבר הקל ביותר הוא [לעשות פורק לריפו בGitHub](https://github.com/qmk/qmk_firmware#fork-destination-box), ולעשות קלון לריפו בסביבה המקומית ושם לבצע את השינויים שלכם, לדחוף אותם ולפתוח [Pull Request](https://github.com/qmk/qmk_firmware/pulls) מהפורק שלך.
17
18אחרת, אפשר להוריד את הקושחה באופן ישיר ([zip](https://github.com/qmk/qmk_firmware/zipball/master), [tar](https://github.com/qmk/qmk_firmware/tarball/master)), או לשכפל אותה באמצעות git (`git@github.com:qmk/qmk_firmware.git`), או https (`https://github.com/qmk/qmk_firmware.git`).
19
20## איך לקמפל
21
22לפני שתצליחו לקמפל, תדרשו [להתקין סביבה](he-il/getting_started_build_tools.md) עבור פיתוח AVR ו/או ARM. ברגע שהדבר בוצע, תוכלו להריץ פקודת `make` כדי לבנות מקלדת ומיפוי עם התחביר הבא:
23
24 make planck/rev4:default
25
26כך תוכלו לבנות את גרסא `rev4` של ה `planck` עם מיפוי ברירת המחדל (`default`). לא כל המקלדות בעלות גרסאות (נקרא גם תת-פרוייקט או תיקייה), במקרה כזה, אפשר להריץ את הפקודה הבאה:
27
28 make preonic:default
29
30## איך להתאים
31
32לQMK יש המון [יכולות](he-il/features.md) שאפשר לנווט בהן, וכמות נכבדת של [תיעוד ודוקומנטציה](https://docs.qmk.fm) בה אפשר לנבור. רוב הפיצ׳רים באים לידי ביטוי על ידי שינוי [מיפוי המקלדת](he-il/keymap.md) ושינוי [קודי המקשים](he-il/keycodes.md).
33</div>
diff --git a/docs/he-il/_summary.md b/docs/he-il/_summary.md
deleted file mode 100644
index 148eb6400..000000000
--- a/docs/he-il/_summary.md
+++ /dev/null
@@ -1,140 +0,0 @@
1<div dir="rtl" markdown="1">
2
3**בשפה העברית**
4* [המדריך המלא למתחילים](he-il/newbs.md)
5 * [מקורות ללמידה](he-il/newbs_learn_more_resources.md)
6* [בסיס QMK](he-il/README.md)
7 * [מבוא לQMK](he-il/getting_started_introduction.md)
8 * [איך להשתמש בGitHub](he-il/getting_started_github.md)
9 * [קבלת עזרה](he-il/getting_started_getting_help.md)
10* [שאלות נפוצות](he-il/faq.md)
11 * [שאלות נפוצות כלליות](he-il/faq_general.md)
12* [חומרה](he-il/hardware.md)
13* התייחסויות
14 * [איך לתעד נכון](he-il/documentation_best_practices.md)
15
16**בשפה האנגלית**
17* [המדריך המלא למתחילים](he-il/newbs.md)
18 * [התחלה](he-il/newbs_getting_started.md)
19 * [בנייה של הקושחה הראשונה שלך](he-il/newbs_building_firmware.md)
20 * [צריבה של הקושחה](he-il/newbs_flashing.md)
21 * [בדיקות ודיבאגינג](he-il/newbs_testing_debugging.md)
22 * [עבודה נכונה ב GIT](he-il/newbs_best_practices.md)
23 * [מקורות ללמידה](he-il/newbs_learn_more_resources.md)
24
25* [בסיס QMK](he-il/README.md)
26 * [מבוא לQMK](he-il/getting_started_introduction.md)
27 * [QMK CLI](he-il/cli.md)
28 * [QMK CLI Config](he-il/cli_configuration.md)
29 * [תרומה ל QMK](he-il/contributing.md)
30 * [איך להשתמש בGitHub](he-il/getting_started_github.md)
31 * [קבלת עזרה](he-il/getting_started_getting_help.md)
32
33* [שינויים משמעותיים](he-il/breaking_changes.md)
34 * [2019 Aug 30](he-il/ChangeLog/20190830.md)
35
36* [שאלות נפוצות](he-il/faq.md)
37 * [שאלות נפוצות כלליות](he-il/faq_general.md)
38 * [בנייה/קומפילציה של QMK](he-il/faq_build.md)
39 * [דיבאגינג ופתרון תקלות של QMK](he-il/faq_debug.md)
40 * [מיפוי מקשים](he-il/faq_keymap.md)
41 * [התקנת דרייברים עם Zadig](he-il/driver_installation_zadig.md)
42
43* מדריכים מפורטים
44 * [התקנת כלי Build](he-il/getting_started_build_tools.md)
45 * [מדריך Vagrant](he-il/getting_started_vagrant.md)
46 * [הוראות בנייה/קומפילציה](he-il/getting_started_make_guide.md)
47 * [צריבת קושחה](he-il/flashing.md)
48 * [התאמה אישית של הפונקציונאליות](he-il/custom_quantum_functions.md)
49 * [מיפוי מקשים](he-il/keymap.md)
50
51* [חומרה](he-il/hardware.md)
52 * [מעבדי AVR](he-il/hardware_avr.md)
53 * [דרייברים](he-il/hardware_drivers.md)
54
55* התייחסויות
56 * [מדריך למקלדות](he-il/hardware_keyboard_guidelines.md)
57 * [אפשרויות הגדרות](he-il/config_options.md)
58 * [קודי מקשים](he-il/keycodes.md)
59 * [קונבנציות קוד - C](he-il/coding_conventions_c.md)
60 * [קונבנציות קוד - Python](he-il/coding_conventions_python.md)
61 * [איך לתעד נכון](he-il/documentation_best_practices.md)
62 * [טמפלטים לדוקומנטציה](he-il/documentation_templates.md)
63 * [מילון](he-il/reference_glossary.md)
64 * [בדיקות יחידה](he-il/unit_testing.md)
65 * [פונקציות שימושיות](he-il/ref_functions.md)
66 * [תמיכה בConfigurator](he-il/reference_configurator_support.md)
67 * [פורמט info.json](he-il/reference_info_json.md)
68 * [פיתוח בPython CLI](he-il/cli_development.md)
69
70* [תכונות](he-il/features.md)
71 * [Basic Keycodes](he-il/keycodes_basic.md)
72 * [US ANSI Shifted Keys](he-il/keycodes_us_ansi_shifted.md)
73 * [Quantum Keycodes](he-il/quantum_keycodes.md)
74 * [Advanced Keycodes](he-il/feature_advanced_keycodes.md)
75 * [Audio](he-il/feature_audio.md)
76 * [Auto Shift](he-il/feature_auto_shift.md)
77 * [Backlight](he-il/feature_backlight.md)
78 * [Bluetooth](he-il/feature_bluetooth.md)
79 * [Bootmagic](he-il/feature_bootmagic.md)
80 * [Combos](he-il/feature_combo.md)
81 * [Command](he-il/feature_command.md)
82 * [Debounce API](he-il/feature_debounce_type.md)
83 * [DIP Switch](he-il/feature_dip_switch.md)
84 * [Dynamic Macros](he-il/feature_dynamic_macros.md)
85 * [Encoders](he-il/feature_encoders.md)
86 * [Grave Escape](he-il/feature_grave_esc.md)
87 * [Haptic Feedback](he-il/feature_haptic_feedback.md)
88 * [HD44780 LCD Controller](he-il/feature_hd44780.md)
89 * [Key Lock](he-il/feature_key_lock.md)
90 * [Layouts](he-il/feature_layouts.md)
91 * [Leader Key](he-il/feature_leader_key.md)
92 * [LED Matrix](he-il/feature_led_matrix.md)
93 * [Macros](he-il/feature_macros.md)
94 * [Mouse Keys](he-il/feature_mouse_keys.md)
95 * [OLED Driver](he-il/feature_oled_driver.md)
96 * [One Shot Keys](he-il/one_shot_keys.md)
97 * [Pointing Device](he-il/feature_pointing_device.md)
98 * [PS/2 Mouse](he-il/feature_ps2_mouse.md)
99 * [RGB Lighting](he-il/feature_rgblight.md)
100 * [RGB Matrix](he-il/feature_rgb_matrix.md)
101 * [Space Cadet](he-il/feature_space_cadet.md)
102 * [Split Keyboard](he-il/feature_split_keyboard.md)
103 * [Stenography](he-il/feature_stenography.md)
104 * [Swap Hands](he-il/feature_swap_hands.md)
105 * [Tap Dance](he-il/feature_tap_dance.md)
106 * [Terminal](he-il/feature_terminal.md)
107 * [Thermal Printer](he-il/feature_thermal_printer.md)
108 * [Unicode](he-il/feature_unicode.md)
109 * [Userspace](he-il/feature_userspace.md)
110 * [Velocikey](he-il/feature_velocikey.md)
111
112* למייקרים ומודרים
113 * [מדריך לכתיבה ידנית](he-il/hand_wire.md)
114 * [מדריך לצריבת ISP](he-il/isp_flashing_guide.md)
115 * [מדריך לדיבאגינג ARM](he-il/arm_debugging.md)
116 * [מנהל התקן I2C](he-il/i2c_driver.md)
117 * [מנהל התקן SPI](he-il/spi_driver.md)
118 * [בקרת GPIO](he-il/internals_gpio_control.md)
119 * [המרת Proton C](he-il/proton_c_conversion.md)
120
121* להבנה עמוקה יותר
122 * [איך עובדות מקלדות](he-il/how_keyboards_work.md)
123 * [להבין את QMK](he-il/understanding_qmk.md)
124
125* נושאים נוספים
126 * [שימוש ב - Eclipse עם QMK](he-il/other_eclipse.md)
127 * [שימוש ב - VSCode עם QMK](he-il/other_vscode.md)
128 * [תמיכה](he-il/getting_started_getting_help.md)
129 * [כיצד להוסיף תרגום](he-il/translating.md)
130
131* QMK מבפנים (בתהליך)
132 * [Defines](he-il/internals_defines.md)
133 * [Input Callback Reg](he-il/internals_input_callback_reg.md)
134 * [Midi Device](he-il/internals_midi_device.md)
135 * [Midi Device Setup Process](he-il/internals_midi_device_setup_process.md)
136 * [Midi Util](he-il/internals_midi_util.md)
137 * [Send Functions](he-il/internals_send_functions.md)
138 * [Sysex Tools](he-il/internals_sysex_tools.md)
139
140</div>
diff --git a/docs/he-il/documentation_best_practices.md b/docs/he-il/documentation_best_practices.md
deleted file mode 100644
index bba9d886a..000000000
--- a/docs/he-il/documentation_best_practices.md
+++ /dev/null
@@ -1,67 +0,0 @@
1<div dir="rtl" markdown="1">
2# איך לתעד נכון
3
4עמוד זה קיים כדי לתעד את השיטות הטובות ביותר כאשר כותבים תיעוד עבור QMK. מעקב אחר הוראות אלה יעזור לשמור על סגנון וטון עקביים, אשר בתורם יעזרו לאנשים אחרים להבין טוב יותר את QMK.
5
6# פתיחת עמוד
7
8התיעוד שלך צריך בד״כ להפתח עם כותרת בגודל H1, אחריה פסקה אחת של תיאור של מה המשתמש ימצא בעמוד זה.
9זכור כי כותרת זו והפסקה ימוקמו ליד תוכן העניינים, אז חשוב לשמור על כותרת קצרה ולהמנע ממשפטים ארוכים ללא פיסוק.
10
11לדוגמה:
12
13```
14# הכותרת שלי
15
16עמוד זה מדבר על היכולת הסופר-מגניבה שלי. אתה יכול להשתמש ביכולת זו כדי להכין קפה, לסחוט תפוזים ולקבל משלוח של ביצים ועוגות מהסופר הקרוב באמצעות רחפן.
17```
18
19# כותרות
20
21עמוד התיעוד צריך לאופן כללי לכלול מס׳ כותרות בגודל "H1". רק כותרות מגודל H1 ו- H2 יכללו בתוכן העניינים, אז חשוב לתכנן אותם בהתאם. הכותרות לא להיות רחבות מידי כדי למנוע מתוכן העניינים להפוך להיות רחב מידי
22
23# בלוקי רמיזה מעוצבים
24
25ניתן להוסיף בלוקי רמיזה מעוצבים שמצויירים מסביב לטקסט כדי למשוך תשומת לב אליו.
26
27### חשוב
28
29```
30!> זה חשוב
31```
32
33יתרנדר כ:
34
35!> זה חשוב
36
37### טיפים כלליים
38
39```
40?> זהו טיפ שימושי.
41```
42
43יתרנדר כ:
44
45?> זהו טיפ שימושי.
46
47
48# תיעוד יכולות ופיצ׳ריםDocumenting Features
49
50אם יוצרים יכולת חדשה ב QMK, צרו עמוד תיעוד עבורה. העמוד לא צריך להיות ארוך במיוחד, מספר משפטים המתארים את היכולת (פיצ׳ר) וטבלה המתארת קודי מקשים רלוונטיים זה מספיק. הנה דוגמה בסיסית:
51
52```markdown
53# הפיצ׳ר המגניב שלי
54
55עמוד זה מדבר על היכולת הסופר-מגניבה שלי. אתה יכול להשתמש ביכולת זו כדי להכין קפה, לסחוט תפוזים ולקבל משלוח של ביצים ועוגות מהסופר הקרוב באמצעות רחפן.
56
57## קודי המקשים המגניבים של היכולת שלי
58
59|Long Name|Short Name|Description|
60|---------|----------|-----------|
61|KC_COFFEE||Make Coffee|
62|KC_CREAM||Order Cream|
63|KC_SUGAR||Order Sugar|
64```
65
66מקמו את התיעוד שלכם בתוך `docs/feature_<my_cool_feature>.md`, והוסיפו קישור לקובץ זה במקום המתאים ב `docs/_sidebar.md`. אם הוספתם קודי מקשים נוספים, תקפידו להוסיף אותם ל- `docs/keycodes.md` עם לינק לעמוד היכולת שלכם.
67</div>
diff --git a/docs/he-il/faq.md b/docs/he-il/faq.md
deleted file mode 100644
index 0a783eb8c..000000000
--- a/docs/he-il/faq.md
+++ /dev/null
@@ -1,8 +0,0 @@
1<div dir="rtl" markdown="1">
2# שאלות נפוצות
3
4* [כללי](faq_general.md)
5* [בנייה או קומפילציה של QMK](faq_build.md)
6* [דיבאגינג ופתרון בעיות של QMK](faq_debug.md)
7* [מיפוי מקשים](faq_keymap.md)
8</div>
diff --git a/docs/he-il/faq_general.md b/docs/he-il/faq_general.md
deleted file mode 100644
index fc102d6c6..000000000
--- a/docs/he-il/faq_general.md
+++ /dev/null
@@ -1,17 +0,0 @@
1<div dir="rtl" markdown="1">
2# שאלות נפוצות
3
4## מה זה QMK?
5
6[QMK](https://github.com/qmk), קיצור עבור Quantum Mechanical Keyboard, הוא קבוצה של אנשים הבונים כלים עבור מקלדות מותאמות אישית. התחלנו עם [קושחת QMK](https://github.com/qmk/qmk_firmware), פורק של [TMK](https://github.com/tmk/tmk_keyboard) אשר שונה באופן ניכר.
7
8## מה ההבדלים העיקריים בין QMK ו-Keymap TMK?
9
10TMK עוצב ומומש במקור ע״י [Jun Wako](https://github.com/tmk). QMK התחיל כפורק של [Jack Humbert](https://github.com/jackhumbert) של הפרוייקט של TMK עבור Planck. אחרי כמה זמן הפורק של ג׳ק השתנה מזה של TMK וב- 2015 ג׳ק החליט לשנות את שמו של הפורק ל- QMK.
11
12מנק׳ מבט טכנית, QMK נבנה על גבי TMK ע״י הוספת יכולות ופיצ׳רים חדשים. ראוי לציון ש- QMK הרחיב את מס׳ קודי המקלדת האפשריים ומשתמש בהם למימוש יכולות מתקדמות כמו `S()`, `LCTL()`, ו- `MO()`. ניתן לראות רשימה מלאה של קודי המקלדת האלה ב - [קודי מקלדת](keycodes.md).
13
14מנק׳ מבט של הפרוייקט וניהול הקהילה, TMK מנהל את כל המקלדות הנתמכות בעצמו, עם מעט תמיכה מהקהילה. כל אחד יכול לעשות פורק מהפרוייקט עבור מקלדות אחרות. רק מס׳ מיפויי מקשים נמצאים בברירת המחדל כך שאנשים בד״כ לא משתפים מיפויי מקשים זה עם זה. QMK מעודד את השיתוף של המקלדות וקודי המקשים דרך רפוזיטורי בניהול מרכזי, אשר מקבל את כל בקשות ה- Pull Requests שעומדות בסטנדרט האיכות. רובם מנוהלות ע״י הקהילה, אבל הצוות של QMK עוזר כשנדרש.
15
16לשתי הגישות יש יתרונות וחסרונות וקוד עובר בחופשיות בין TMK ל- QMK כשצריך.
17</div>
diff --git a/docs/he-il/getting_started_getting_help.md b/docs/he-il/getting_started_getting_help.md
deleted file mode 100644
index 7dec3e87d..000000000
--- a/docs/he-il/getting_started_getting_help.md
+++ /dev/null
@@ -1,17 +0,0 @@
1<div dir="rtl" markdown="1">
2# קבלת עזרה
3
4ישנם משאבים רבים לצורך קבלת עזרה עם QMK.
5
6## צ׳אט בזמן אמת
7
8אפשר למצוא מפתחי QMK ומשתמשים [בשרת ה-Discord הראשי שלנו](https://discord.gg/Uq7gcHh). ישנם ערוצים ספציפיים בשרת לצורך שיחות על הקושחה, ארגז הכלים, חומרה והמגדיר.
9
10## סאב-רדיט OLKB
11
12הפורום הרשמי של QMK נמצא ב - [/r/olkb](https://reddit.com/r/olkb) באתר [reddit.com](https://reddit.com).
13
14## סוגיות GitHub
15
16ניתן לפתוח [סוגייה ב-GitHub](https://github.com/qmk/qmk_firmware/issues). הדבר שימושי במיוחד כאשר הסוגיה דורשת דיון עמוק וארוך או דיבאגינג.
17</div>
diff --git a/docs/he-il/getting_started_github.md b/docs/he-il/getting_started_github.md
deleted file mode 100644
index ca79e40f9..000000000
--- a/docs/he-il/getting_started_github.md
+++ /dev/null
@@ -1,74 +0,0 @@
1<div dir="rtl" markdown="1">
2# איך להשתמש ב-GitHub עם QMK
3
4GitHub עלול להיות קצת טריקי למי שלא מכיר את העבודה איתו - מדריך זה ילווה אתכם שלב אחר שלב דרך ביצוע פעולות fork, clone ו-pull request עם QMK.
5
6?> מדריך זה מניח שאתם מרגישים בנוח עם הרצה של פקודות בסביבת command line (שורת הפקודה) ו-git מותקן במערכת שלכם.
7
8התחילו ב- [עמוד של QMK ב-GitHub](https://github.com/qmk/qmk_firmware), ותצמאו כפתור בחלק העליון מימין עם התיכוב "Fork":
9
10![Fork ב-GitHub](https://i.imgur.com/8Toomz4.jpg)
11
12אם אתם חלק מארגון, תצטרכו לבחור לאיזה חשבון לבצע פעולת fork. ברוב המבקרים, תרצו לבצע fork לתוך החשבון הפרטי שלכם. ברגע שה-fork הסתיים (לפעמים זה יכול לקחת קצת זמן) הקליקו על כפתור ה-"Clone or Download":
13
14![הורדה מ-GitHub](https://i.imgur.com/N1NYcSz.jpg)
15
16תוודאו שאתם בוחרים באופצייה של "HTTPS", בחרו את הקישור והעתיקו אותו:
17
18![קישור HTTPS](https://i.imgur.com/eGO0ohO.jpg)
19
20מכאן והלאה, הקיש `git clone --recurse-submodules ` בשורת הפקודה והדביקו את הלינק שלכם:
21
22<div dir="ltr" markdown="1">
23
24```
25user@computer:~$ git clone --recurse-submodules https://github.com/whoeveryouare/qmk_firmware.git
26Cloning into 'qmk_firmware'...
27remote: Enumerating objects: 9, done.
28remote: Counting objects: 100% (9/9), done.
29remote: Compressing objects: 100% (5/5), done.
30remote: Total 183883 (delta 5), reused 4 (delta 4), pack-reused 183874
31Receiving objects: 100% (183883/183883), 132.90 MiB | 9.57 MiB/s, done.
32Resolving deltas: 100% (119972/119972), done.
33...
34Submodule path 'lib/chibios': checked out '587968d6cbc2b0e1c7147540872f2a67e59ca18b'
35Submodule path 'lib/chibios-contrib': checked out 'ede48346eee4b8d6847c19bc01420bee76a5e486'
36Submodule path 'lib/googletest': checked out 'ec44c6c1675c25b9827aacd08c02433cccde7780'
37Submodule path 'lib/lufa': checked out 'ce10f7642b0459e409839b23cc91498945119b4d'
38```
39
40</div>
41
42כעת, יש לכם את ה-fork של QMK על המכונה המקומית שלכם ואתם יכולים להוסיף את מיפויי המקשים שלכם, לקמפל את הפרוייקט ולצרוב אותו על הלוח שלכם. כשאתם שלמים עם השינוי שעשיתם, תוכלו להוסיף, לבצע פעולת commit ולדחוף את השינויים ל-fork שלכם באופן הבא:
43
44<div dir="ltr" markdown="1">
45
46```
47user@computer:~$ git add .
48user@computer:~$ git commit -m "adding my keymap"
49[master cccb1608] adding my keymap
50 1 file changed, 1 insertion(+)
51 create mode 100644 keyboards/planck/keymaps/mine/keymap.c
52user@computer:~$ git push
53Counting objects: 1, done.
54Delta compression using up to 4 threads.
55Compressing objects: 100% (1/1), done.
56Writing objects: 100% (1/1), 1.64 KiB | 0 bytes/s, done.
57Total 1 (delta 1), reused 0 (delta 0)
58remote: Resolving deltas: 100% (1/1), completed with 1 local objects.
59To https://github.com/whoeveryouare/qmk_firmware.git
60 + 20043e64...7da94ac5 master -> master
61```
62
63</div>
64
65השינויים שלכם יופיעו ב-fork שלכם ב-GitHub - אם תחזרו לשם (`https://github.com/<whoeveryouare>/qmk_firmware`), תוכלו ליצור "Pull Request חדש" ע״י הקשה על הכפתור הבא:
66
67![Pull Request חדש](https://i.imgur.com/DxMHpJ8.jpg)
68
69כאן תוכלו לראות בדיוק למה עשיתם commit - אם הכל נראה תקין, תוכלו להשלים את הפעולה ע״י הקשה על "Create Pull Request":
70
71![צרו Pull Request](https://i.imgur.com/Ojydlaj.jpg)
72
73אחרי שהגשתם, אנו עלולים לפנות אליכם לגבי השינויים שהצעתם, נבקש שתבצעו שינויים ובסופו של דבר נקבל את השינויים! תודה שתרמתם לפרוייקט QMK :)
74</div>
diff --git a/docs/he-il/getting_started_introduction.md b/docs/he-il/getting_started_introduction.md
deleted file mode 100644
index fca86bdaa..000000000
--- a/docs/he-il/getting_started_introduction.md
+++ /dev/null
@@ -1,72 +0,0 @@
1<div dir="rtl" markdown="1">
2# מבוא
3
4עמוד זה מנסה להסביר את המידע הבסיסי אותו תדרשו לדעת כדי לעבוד עם פרוייקט QMK. הוא מניח שאתם יודעים איך לנווט בסביבת Unix Shell, אבל לא מניח שאתם מכירים את שפת C או קומפילציה באמצעות make.
5
6## מבנה QMK בסיסי
7
8QMK הוא פורק של הפרוייקט [tmk_keyboard](https://github.com/tmk/tmk_keyboard) של [Jun Wako](https://github.com/tmk). קוד הTMK המקורי, עם התאמות, יכול להמצא בתיקיית `tmk_core`. התוספות של QMK לפרוייקט יכולות להמצא בתיקיית `quantum`. פרוייקטי מקלדות יכולות להמצא בתיקיות `handwired` ו- `keyboard`.
9
10### מבנה אחסון המשתמש
11
12בתוך תיקיית `users` יש תיקייה לכל משתמש. זה המקום למשתמשים להוסיף קוד שהם רוצים להשתמש בו במקלדות שונות. מומלץ לעיין במסמך [תכונות אחסון המשתמש](feature_userspace.md) לקבלת מידע נוסף.
13
14### מבנה פרוייקט המקלדת
15
16בתוך תיקיית `keyboards`, תת התיקייה `handwired` ותת התיקיות של היצרן והמוכר, לדוגמה `clueboard` היא תיקייה לכל פרוייקט מקלדת - `qmk_firmware/keyboards/clueboard/2x1800` בתוך התיקייה הזאת תמצאו את המבנה הבא:
17
18
19* `keymaps/`: מיפויי מקשים שונים היכולים להבנות
20* `rules.mk`: קובץ המגדיר את הגדרות ברירת המחדל של `make`. נא לא לערוך את הקובץ ישירות, במקום זאת, השתמשו בקובץ מיפוי המקשים ספציפי `rules.mk`.
21* `config.h`: הקובץ מכיל הגדרות לזמן הקומפילציה. נא לא לערוך את הקובץ ישירות אלא להשתמש בקובץ `config.h` לכל מיפויי מקשים.
22* `info.json`: הקובץ מכיל הגדרות פריסה עבור QMK Configurator. צפו ב [תמיכת Configurator](reference_configurator_support.md) למידע נוסף.
23* `readme.md`: סקירה כללית של המקלדת.
24* `<keyboardName>.h`: הקובץ בו פריסת המקלדת מוגדרת אל מול מטריצת המתגים של המקלדת.
25* `<keyboardName>.c`: הקובץ בו ניתן למצוא קוד מותאם למקלדת.
26
27למידע נוסף - אנא הכנסו ל [QMK](hardware_keyboard_guidelines.md).
28For more information on project structure, see [QMK מדריך למקלדת](hardware_keyboard_guidelines.md).
29
30### מבנה מפיוי המקשים
31
32בכל ספריית מיפוי מקשים, הקבצים הבאים עלולים להמצא. רק הקובץ `keymap.c` הוא חובה, אם השאר לא נמצאים, אפשרויות ברירת המחדל יבחרו.
33In every keymap folder, the following files may be found. Only `keymap.c` is required, and if the rest of the files are not found the default options will be chosen.
34
35* `config.h`: ההגדרות השונות עבור מיפוי המקשים.
36* `keymap.c`: כל הקודים של מיפוי המקשים, קובץ חובה
37* `rules.mk`: אילו יכולות של QMK מאופשרות.
38* `readme.md`: הסבר על מיפוי המקשים, איך אחרים ישתמשו בו והסבר על היכולות. נא להעלות תמונות לשירותים כמו imgur.
39
40# קובץ `config.h`
41
42לקובץ `config.h` יש 3 מיקומים אפשריים:
43
44* keyboard (`/keyboards/<keyboard>/config.h`)
45* userspace (`/users/<user>/config.h`)
46* keymap (`/keyboards/<keyboard>/keymaps/<keymap>/config.h`)
47
48מערכת הבילד אוטומטית בוחרת את קובץ ההגדרות לפי הסדר הנ״ל. אם רוצים לדרוס הגדרה מסויימת שהוגדרה בקובץ `config.h` קודם, ראשית תצטרכו להשתמש בקוד מוכן עבור ההגדרות שאתם רוצים לשנות.
49
50<div dir="ltr" markdown="1">
51
52```
53#pragma once
54```
55
56</div>
57
58כדי לדרוס הגדרות מקובץ `config.h` קודם, אתם מוכרחים להשתמש בפקודת `#undef` ואז שוב `#define`.
59
60דוגמה לקוד כזה נראית כך:
61<div dir="ltr" markdown="1">
62
63```
64#pragma once
65
66// overrides go here!
67#undef MY_SETTING
68#define MY_SETTING 4
69```
70
71</div>
72</div>
diff --git a/docs/he-il/hardware.md b/docs/he-il/hardware.md
deleted file mode 100644
index fca03bd64..000000000
--- a/docs/he-il/hardware.md
+++ /dev/null
@@ -1,10 +0,0 @@
1<div dir="rtl" markdown="1">
2# חומרה
3
4QMK רצה על מגוון של חומרות. אם המעבד שלך יכול להיות ממוקד (מטורגט) ע״י [LUFA](https://www.fourwalledcubicle.com/LUFA.php) או [ChibiOS](https://www.chibios.org) כנראה שתוכל לגרום ל QMK לרוץ על המעבד. קטע זה מדבר על הרצת QMK, ותקשורת עם, סוגים שונים של חומרות.
5
6* [מדריך למקלדת](hardware_keyboard_guidelines.md)
7* [מעבדי AVR](hardware_avr.md)
8* מעבדי ARM (TBD)
9* [מנהלי התקנים](hardware_drivers.md)
10</div>
diff --git a/docs/he-il/newbs_learn_more_resources.md b/docs/he-il/newbs_learn_more_resources.md
deleted file mode 100644
index 4127c387f..000000000
--- a/docs/he-il/newbs_learn_more_resources.md
+++ /dev/null
@@ -1,16 +0,0 @@
1<div dir="rtl" markdown="1">
2# מקורות ללמידה
3
4המקורות הבאים מטרתם היא לתת למשתמשים חדשים בקהילת QMK כדי להבין לעומק את המידע שמגיע במסמכי המתחילים.
5
6מקורות גיט:
7
8* [מדריך כללי מעולה](https://www.codecademy.com/learn/learn-git)
9* [משחק גיט כדי ללמוד מדוגמאות](https://learngitbranching.js.org/)
10* [מקורות גיט כדי ללמוד עוד על GitHub](getting_started_github.md)
11* [מקור גיט כדי ללמוד במפורש על QMK](contributing.md)
12
13מקורות לפקודות שורה (Command Line):
14
15* [מדריך טוב על Command Line](https://www.codecademy.com/learn/learn-the-command-line)
16</div>
diff --git a/docs/he-il/proton_c_conversion.md b/docs/he-il/proton_c_conversion.md
deleted file mode 100644
index 9642ca309..000000000
--- a/docs/he-il/proton_c_conversion.md
+++ /dev/null
@@ -1,36 +0,0 @@
1<div dir="rtl" markdown="1">
2# המרה של לוח להשתמש ב-Proton C
3
4אם לוח נתמך ב-QMK משתמש בלוח Pro Micro (או כל לוח נתמך) ואתם רוצים להשתמש ב-Proton C, ניתן לייצר את החומרה ע"י הוספה של הפקודה `CONVERT_TO_PROTON_C=yes` (או `CTPC=yes`) לפקודת make, כמו כאן:
5<div dir="ltr" markdown="1">
6
7```
8 make 40percentclub/mf68:default CTPC=yes
9```
10
11</div>
12ניתן להוסיף את אותו ארגומנט לקובץ `rules.mk` במיפוי המקשים שלכם, שתיצור את אותה התוצאה.
13
14הדבר חושף את דגל `CONVERT_TO_PROTON_C` שניתן להשתמש בו בקוד שלכם באמצעות פקודת `#ifdef`, כמו כאן:
15<div dir="ltr" markdown="1">
16
17```
18 #ifdef CONVERT_TO_PROTON_C
19 // Proton C code
20 #else
21 // Pro Micro code
22 #endif
23```
24
25</div>
26לפני שתצליחו לקמפל, יכול להיות שתקבלו שגיאות שונות לגבי `PORTB/DDRB`, וכו' שלא הוגדרו, אם כך, תצטרכו להמיר את קודי המקלדת להשתמש ב - [בקרי GPIO](internals_gpio_control.md) שיעבדו עבור ARM וגם AVR. הדבר לא אמור להשפיע על הבילדים של AVR בכלל.
27
28ל-Proton C יש רק מנורת LED אחת על הלוח (C13), וכברירת מחדל, TXLED (D5) ממופה אליו. אם תרצו במקום, למפות אליו את RXLED (B0), הוסיפו את השורה הבא לקובץ `config.h`:
29<div dir="ltr" markdown="1">
30
31```
32 #define CONVERT_TO_PROTON_C_RXLED
33```
34
35</div>
36</div>
diff --git a/docs/he-il/quantum_keycodes.md b/docs/he-il/quantum_keycodes.md
deleted file mode 100644
index 5374fd47a..000000000
--- a/docs/he-il/quantum_keycodes.md
+++ /dev/null
@@ -1,25 +0,0 @@
1<div dir="rtl" markdown="1">
2# קודי מקלדת Quantum
3
4קודי מקלדת Quantum מאפשרים התאמה נוחה יותר של מיפוי המקשים שלך מעבר למה שהבסיסי מאפשר, ללא צורך בהגדרת של פעולות מותאמות אישית.
5
6כל קודי המקלדת בתוך quantum הם מספרים בין `0x0000` ֿֿֿ ל-`0xFFFF`. בתוך הקובץ `keymap.c` זה עלול להראות כאילו יש לך פונקציות ומקרים יחודיים נוספים, אבל בסופו של דבר הקדם-מעבד של שפת C יתרגם אלה לתוך מספר יחיד בין 4 בתים. QMK שמרה את מרחב הכתובות בין `0x0000` עד ל- `0x00FF` עבור קודי מקשים סטנדרטיים. קודי מקשים אלה, כגון `KC_A`, `KC_1`, ו- `KC_LCTL`, אשר מתארים מקשים בסיסיים מוגדרים בתוך USB HID specification.
7
8בעמודו זה יש לנו את קודי המקשים מתועדים בין `0x00FF` ֿֿ ל- `0xFFFF` אשר משומשים בשביל לממש יכולות מתקדמות של quantum. אם תגדירו קודי מקשים משלכם, הם יתווספו לתוך המרחב הזה גם כן.
9
10## קודי מקשים של QMK
11<div dir="ltr" markdown="1">
12
13```
14|Key |Aliases |Description |
15|---------------|-----------|---------------------------------------------------------------------|
16|`RESET` | |Put the keyboard into DFU mode for flashing |
17|`DEBUG` | |Toggle debug mode |
18|`EEPROM_RESET` |`EEP_RST` |Resets EEPROM state by reinitializing it |
19|`KC_GESC` |`GRAVE_ESC`|Escape when tapped, <code>&#96;</code> when pressed with Shift or GUI|
20|`KC_LEAD` | |The [Leader key](feature_leader_key.md) |
21|`KC_LOCK` | |The [Lock key](feature_key_lock.md) |
22```
23
24</div>
25</div>
diff --git a/docs/index.html b/docs/index.html
index 5312b9105..f5a8dbbf1 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -51,13 +51,7 @@
51 basePath: '/', 51 basePath: '/',
52 name: 'QMK Firmware', 52 name: 'QMK Firmware',
53 nameLink: { 53 nameLink: {
54 '/de/': '/#/de/',
55 '/es/': '/#/es/',
56 '/fr-fr/': '/#/fr-fr/',
57 '/he-il/': '/#/he-il/',
58 '/ja/': '/#/ja/', 54 '/ja/': '/#/ja/',
59 '/pt-br/': '/#/pt-br/',
60 '/ru-ru/': '/#/ru-ru/',
61 '/zh-cn/': '/#/zh-cn/', 55 '/zh-cn/': '/#/zh-cn/',
62 '/': '/#/' 56 '/': '/#/'
63 }, 57 },
@@ -68,30 +62,20 @@
68 auto2top: true, 62 auto2top: true,
69 autoHeader: true, 63 autoHeader: true,
70 fallbackLanguages: [ 64 fallbackLanguages: [
71 'de',
72 'es',
73 'fr-fr',
74 'he-il',
75 'ja', 65 'ja',
76 'pt-br',
77 'ru-ru',
78 'zh-cn' 66 'zh-cn'
79 ], 67 ],
80 formatUpdated: '{YYYY}/{MM}/{DD} {HH}:{mm}', 68 formatUpdated: '{YYYY}/{MM}/{DD} {HH}:{mm}',
81 search: { 69 search: {
82 paths: 'auto', 70 paths: 'auto',
83 placeholder: { 71 placeholder: {
84 '/es/': 'Buscar',
85 '/zh-cn/': '搜索', 72 '/zh-cn/': '搜索',
86 '/ja/': '検索', 73 '/ja/': '検索',
87 '/pt-br/': 'Busca',
88 '/': 'Search' 74 '/': 'Search'
89 }, 75 },
90 noData: { 76 noData: {
91 '/es/': '¡Ningún resultado!',
92 '/zh-cn/': '没有结果!', 77 '/zh-cn/': '没有结果!',
93 '/ja/': '見つかりません!', 78 '/ja/': '見つかりません!',
94 '/pt-br/': 'Nenhum resultado!',
95 '/': 'No results!' 79 '/': 'No results!'
96 }, 80 },
97 depth: 6 81 depth: 6
@@ -103,21 +87,14 @@
103 copyCode: { 87 copyCode: {
104 buttonText: { 88 buttonText: {
105 '/zh-cn/': '点击复制', 89 '/zh-cn/': '点击复制',
106 '/ru/' : 'Скопировать в буфер обмена',
107 '/de-de/': 'Klicken Sie zum Kopieren',
108 '/es/' : 'Haga clic para copiar',
109 '/' : 'Copy to clipboard' 90 '/' : 'Copy to clipboard'
110 }, 91 },
111 errorText: { 92 errorText: {
112 '/zh-cn/': '错误', 93 '/zh-cn/': '错误',
113 '/ru/' : 'ошибка',
114 '/' : 'Error' 94 '/' : 'Error'
115 }, 95 },
116 successText: { 96 successText: {
117 '/zh-cn/': '复制', 97 '/zh-cn/': '复制',
118 '/ru/' : 'Скопировано',
119 '/de-de/': 'Kopiert',
120 '/es/' : 'Copiado',
121 '/' : 'Copied' 98 '/' : 'Copied'
122 } 99 }
123 }, 100 },
diff --git a/docs/ko-kr/README.md b/docs/ko-kr/README.md
deleted file mode 100644
index a3b5b9101..000000000
--- a/docs/ko-kr/README.md
+++ /dev/null
@@ -1,32 +0,0 @@
1# Quantum Mechanical Keyboard Firmware
2
3[![Current Version](https://img.shields.io/github/tag/qmk/qmk_firmware.svg)](https://github.com/qmk/qmk_firmware/tags)
4[![Discord](https://img.shields.io/discord/440868230475677696.svg)](https://discord.gg/Uq7gcHh)
5[![Docs Status](https://img.shields.io/badge/docs-ready-orange.svg)](https://docs.qmk.fm)
6[![GitHub contributors](https://img.shields.io/github/contributors/qmk/qmk_firmware.svg)](https://github.com/qmk/qmk_firmware/pulse/monthly)
7[![GitHub forks](https://img.shields.io/github/forks/qmk/qmk_firmware.svg?style=social&label=Fork)](https://github.com/qmk/qmk_firmware/)
8
9## QMK Firmware 란?
10
11QMK(*Quantum Mechanical Keyboard 양자 기계식 키보드*)란 QMK 컴워어, QMK 툴박스, qmk.fm 를 관리하고 있는 오픈소스 커뮤니티 입니다. QMK펌웨어는 [tmk\_keyboard](https://github.com/tmk/tmk_keyboard)를 바탕으로 만들어진 키보드펌웨어이며, Atmel AVR컨트롤러와 [OLKB 제품군](https://olkb.com) [ErgoDox EZ](https://www.ergodox-ez.com), 그리고 [Clueboard 제품군](https://clueboard.co/) 이용할때 매우 편리합니다. 또한 QMK는 ChibiOS를 사용하여 ARM기반의 컨트롤러로도 사용할수 있습니다. 마지막으로 QMK는 커스텀회로와 핸드와이어드 키보드을 작동시키는데에도 사용가능합니다.
12
13
14## 설치하기
15
16만약 당신이 QMK에 키보드, 키맵, 또는 새로운 기능을 추가하고싶다면, 가장쉬운 방법은 Github를 통해 [저장소(REPO)를 추가하고]((https://github.com/qmk/qmk_firmware#fork-destination-box)) 로컬에서 변화 또는 수정하고, [PULL REQUEST](https://github.com/qmk/qmk_firmware/pulls)을 통해 업로드 할수 있습니다.
17
18또다른 방법으로는, 직접 파일들 로컬로 다운로드 하거나([zip](https://github.com/qmk/qmk_firmware/zipball/master), [tar](https://github.com/qmk/qmk_firmware/tarball/master)), git (`git@github.com:qmk/qmk_firmware.git`), https (`https://github.com/qmk/qmk_firmware.git`)을 통해 클론을 만들수 있습니다.
19
20## 컴파일
21
22먼저 컴파일을 하기전 AVR 이나 ARM [개발환경](getting_started_build_tools.md)을 구축해야 합니다. 모든준비가 끝났다면 `make`를 다음과 같이 키보드와 키맵을 선택하여 컴파일 할 수 있습니다.
23
24 make planck/rev4:default
25
26이 커맨드는 `rev4`버전의 `planck`를 `default`키맵으로 컴파일 할것입니다. 다만 모든 키보드는 파일, 수정본 또는 세부프로젝트를 가지고있지 않음으로 수정본 부분을 생략될수 있습니다.
27
28 make preonic:default
29
30## 커스터마이징
31
32QMK는 사용할 수 있는 매우 다양한 [기능](features.md)과 체계화된 [참고자료](https://docs.qmk.fm)들이 있습니다. 그중 대부분은 [키맵](keymap.md)을 수정하거나 [키코드](keycodes.md)를 변경하는데에 특화되어 있습니다.
diff --git a/docs/ko-kr/getting_started_build_tools.md b/docs/ko-kr/getting_started_build_tools.md
deleted file mode 100644
index c5aa8d0c0..000000000
--- a/docs/ko-kr/getting_started_build_tools.md
+++ /dev/null
@@ -1,156 +0,0 @@
1# 컴파일 도구 설치
2
3이 페이지는 QMK 컴파일 환경을 설치하는 방법을 설명합니다. 이 페이지는 AVR 프로세서들(예를 들면 atmega32u4와 비슷한)을 위한 가이드를 제공합니다
4
5<!-- FIXME: We should have ARM instructions somewhere. -->
6
7
8**노트:** 만약 당신이 처음 시작한다면 [입문자를 위한 가이드](newbs.md)페이지를 확인하세요.
9
10계속하기전에 당신의 서브모듈(외부라이브러리)이 최신인지 `make git-submodule`을 사용하여 확인하세요.
11
12## 리눅스
13
14당신이 항상 최신 파일을 가지고 있는지는 `sudo util/qmk_install.sh`을 이용하여 간단히 확인할 수 있습니다. 이 명령어는 당신이 필요한 모든 속성물(dependencies)를 설치할 것입니다. **이 명령어는 `apt-get upgrade`를 사용합니다**
15
16또한 당신의 직접 필요한 것들을 설치할 수도 있습니다. 하지만 이 자료는 항상 최신의 자료을 가지고 있지 않습니다.
17
18현재로써 필요한 것은 다음과 같습니다. 하지만 당신이 하는 작업에 따라 당신은 다음 패키지를 다 쓰지 않을 수도 있습니다. 또한 환경에 따라 모든 다음 패키지는 다른이름으로 존재하거나, 없을 수도 있습니다.
19
20```
21build-essential
22gcc
23unzip
24wget
25zip
26gcc-avr
27binutils-avr
28avr-libc
29dfu-programmer
30dfu-util
31gcc-arm-none-eabi
32binutils-arm-none-eabi
33libnewlib-arm-none-eabi
34git
35```
36
37당신이 사용하는 패키지 매니져에서 이러한 방법으로 설치하십시요.
38
39데비안 / 우분투 예시:
40
41 sudo apt-get update
42 sudo apt-get install gcc unzip wget zip gcc-avr binutils-avr avr-libc dfu-programmer dfu-util gcc-arm-none-eabi binutils-arm-none-eabi libnewlib-arm-none-eabi
43
44페도라 / 레드햇 예시:
45
46 sudo dnf install gcc unzip wget zip dfu-util dfu-programmer avr-gcc avr-libc binutils-avr32-linux-gnu arm-none-eabi-gcc-cs arm-none-eabi-binutils-cs arm-none-eabi-newlib
47
48아치 / 맨자로(Manjaro) 예시:
49
50 pacman -S base-devel gcc unzip wget zip avr-gcc avr-binutils avr-libc dfu-util arm-none-eabi-gcc arm-none-eabi-binutils arm-none-eabi-newlib git dfu-programmer dfu-util
51
52## 닉스 (NIX)
53
54만약 당신이 [NixOS](https://nixos.org/)를 사용중이거나 NIX를 리눅스 또는 맥에서 사용중이라면 `nix-shell`를 root 디렉토리에서 사용하여 컴파일 환경의 구축할 수 있습니다.
55
56기본적으로 다음 커맨드는 AVR과 ARM 컴파일러를 설치할것입니다. 만약 필요 없다면 `avr` 또는 `arm`을 인수에서 해제할 수 있습니다.
57
58 nix-shell --arg arm false
59
60## 맥
61당신이 홈브루([homebrew](https://brew.sh/))를 사용한다면, 다음을 입력하세요.
62
63 brew tap osx-cross/avr
64 brew tap PX4/homebrew-px4
65 brew update
66 brew install avr-gcc@7
67 brew link --force avr-gcc@7
68 brew install dfu-programmer
69 brew install dfu-util
70 brew install gcc-arm-none-eabi
71 brew install avrdude
72
73이 방법을 가장 추천합니다. 만약 홈브루가 없다면 커맨드라인 환경에서 매우 편한 [Homebrew](https://brew.sh/)를 다운받는 것을 추천합니다. 참고로 `avr-gcc@7`를 설치하는 중 `make`과 `make install`는 대개 20분 넘게 걸리고 CPU 사용량이 높아집니다.
74
75## msys2를 사용하는 윈도우 (추천)
76윈도우 비스타 부터 최신버젼까지 가장추천되는 환경은 [msys2](https://www.msys2.org)를 이용하는 것입니다. (윈도우 7과 윈도우 10에서 모두 테스트되었음)
77
78* 이 사이트에 있는 설명을 이용해 msys2를 설치하세요: https://www.msys2.org
79* ``MSYS2 MingGW 64-bit`` 를 여세요
80* QMK폴더로 이동하세요. c드라이브 루트에 있는경우:
81 * `$ cd /c/qmk_firmware`
82* `util/qmk_install.sh`을 실행시키고 나오는데요 따라하세요
83
84### 크리에이터 업데이트
85만약 당신의 윈도우 10이 크리에이터 업데이트 버전 또는 더 높은 버전이라면 바로 컴파일과 프로그램 업로드(flashing)를 할 수 있습니다. 크리에이터 업데이트 전 버전이라면 컴파일만 가능합니다. 만약 당신이 잘 모르겠거나 업데이트된 버전이 아니라면 [이 링크](https://support.microsoft.com/en-us/instantanswers/d4efb316-79f0-1aa1-9ef3-dcada78f3fa0/get-the-windows-10-creators-update)를 확인해 보십시오.
86
87### 리눅스용 윈도우 하위 시스템 사용 (Windows10 Subsystem for Linux)
88크리에이터 업데이트에 추가로 만약 당신이 리눅스용 윈도우 하위 시스템이 필요하다면 이 링크에서 다운받으십시오: [설명](https://www.howtogeek.com/249966/how-to-install-and-use-the-linux-bash-shell-on-windows-10/)
89
90만약 당신이 이미 리눅스용 윈도우 하위 시스템을 Anniversary업데이트를 통해 받았다면 이 링크에서 16.04LTS로 업데이트 하는것을 추천합니다. 왜냐하면 업데이트 없이는 일부키보드가 14.04LTS에 포함되있는 도구들로 컴파일되지 않을수 있기때문입니다 : [WSL 업데이트](https://betanews.com/2017/04/14/upgrade-windows-subsystem-for-linux/)
91
92
93### Git
94만약 당신이 이미 파일을 로컬로 복제하였다면 이 섹션을 무시하십시요.
95
96당신은 파일을 기본적인 git을 사용하여 로컬로 복제해야 합니다. **주의, WSL Git을 사용하면 안됩니다** [Git](https://git-scm.com/download/win) 이 링크에서 git을 다운받고 설치하십시오.
97그리고 [기본설정](https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup), 유저네임과 이메일을 설정하는 것은 만약 당신이 온라인에 기여할 계획이라면 매우 중요합니다.
98
99Git의 설치가 완료되었다면 Git Bash커맨드을 열고 당신의 복제 QMK파일이 있는 위치로 이동하고 `git clone --recurse-submodules https://github.com/qmk/qmk_firmware`를 실행 시키십니오. 이 커맨드는 새로운 `qmk_firmware`폴더를 이미 존재하는 것의 하위 폴더설정으로 생성할 것입니다.
100
101### 도구(Toolchain) 설정
102기본적으로 도구설정은 리눅스용 윈도우 하위 시스템이 설치될때 자동으로 설정됩니다. 하지만 수동적으로 하고 싶다면 여기 설명이 있습니다. (If you want to do everything manually, there are no other instructions than the scripts themselves, but you can always open issues and ask for more information. )
103
1041. "Bash On Ubuntu On Windows" 을 실행시키십시오.
1052. 당신이 `qmk_firmware`를 복제한 위치로 가십시오. WSL(리눅스용 윈도우 하위 시스템 사용)에서 `/mnt/`로 시작되는 패스를 찾으십시오. 즉 당신은 다음과 같은 형식으로 입력해야 합니다. `cd /mnt/c/path/to/qmk_firmware` (Note that the paths start with `/mnt/`in the WSL, so you have to write for example `cd /mnt/c/path/to/qmk_firmware`.)
1063. `util/wsl_install.sh`를 실행시키고 화면에 나오는 지시를 따르십니오.
1074. Bash command window를 재실행 시키십시오.
1085. 이로써 당신은 컴파일과 프로그램 업로드(flashing)을 위한 준비가 모두 끝났습니다.
109
110### 중요한 참고사항
111*`util/wsl_install.sh` 명령어를 다시 실행시켜 최신 업데이트를 다운받을 수 있습니다.
112* QMK 폴더의 위치는 윈도우 파일시스템을 기반으로 해야 됩니다. WSL는 외부실행파일를 작동 시킬수 없기 때문이죠.
113* WSL의 Git은 윈도우용 Git과 **호환되지 않습니다**
114* 파일을 수정하는 것은 WSL안과 밖에서 모두 가능합니다 하지만 만약 .makefile 혹은 .sh를 수정한다면 유닉스 라인엔딩(Unix line endings)을 지원하는 에디터를 사용하는지 확인하십이오. 그렇지 않다면 컴파일이 되지않을 수도 있습니다.
115
116## 윈두우 (비스타 혹은 더 최신) (비추천)
117
118이 섹션은 윈도우 비스타 혹은 더 최신버젼을 위한 오래된 설명입니다. [MSYS2](#windows-with-msys2-recommended)를 사용하는 것을 더 추천합니다.
119
1201. WinAVR을 설치하였다면 먼저 삭제하십시오.
1212. [MHV AVR Tools](https://infernoembedded.com/sites/default/files/project/MHV_AVR_Tools_20131101.exe)을 설치하십시오. (Disable smatch, but **be sure to leave the option to add the tools to the PATH checked**)
1223. 만약 당신이 Infinity을 기반으로 하는 키보드에 프로그램 업로드를(flashing) 할거라면 dfu-util을 설치해야 합니다, [Input Club](https://github.com/kiibohd/controller/wiki/Loading-DFU-Firmware) 를 참고 하십시오.
1234. [MinGW](https://sourceforge.net/projects/mingw/files/Installer/mingw-get-setup.exe/download)를 설치하십시오. 설치중 윈도우화면에서 GUI 추가 설치 옵션을 해재하십니오. **기본 설치 위치를 바꾸지 마십시오.** 이 명령어는 기본위치를 기반으로 하고 있습니다.
1245. 레파지토리를 복제하십시오. [이 링크로 압축파일을 받고 앞축해제 하십시오.](https://github.com/qmk/qmk_firmware/archive/master.zip) 윈도우 탐색기에서 다운받은 파일을 여십시오.
1256. `\util` 폴더를 여십시오.
1267. `1-setup-path-win` .bat파일을 더블클릭해서 실행시키시오. 유저 계정 설정 변경을 허용해야될 수도 있습니다. 스페이스바를 눌러 설치가 성공적으로 완료되었다는 메세지를 닫을 수 있습니다.
1278. `2-setup-environment-win` .bat파일에 우클릭해서 '관리자 권한으로 실행'으로 실행시키십시오. 이 작업을 꽤 오래 걸릴 수도 있습니다. 또한 드라이버 설정을 승인해야 될 수도 있습니다. 하지만 이 모든것이 끝나면 당신의 시스템의 설정이 모두 끝났습니다.
128
129만약 이 작업을 하는데에 문제가 있어 도움받고 싶다면 *Win_Check_Output.txt*을 생성하는 것이 도움이 될것입니다. 이 파일은 `Win_Check.bat`을 `\util`폴더에서 실행시켜 생성할 수 있습니다.
130
131## 도커(Docker)
132만약 위작업들이 당신에게 좀 어렵게 느껴졌다면 도커(Docker)가 당신을 위한 최선일 수도 있습니다(의역). [Docker CE](https://docs.docker.com/install/#supported-platforms)를 설치한뒤 아래 커맨드를 `qmk_firmware` 디랙토리에서 실행시켜 키보드 또는 키맵을 생성시킵니다.
133```bash
134util/docker_build.sh keyboard:keymap
135# 예: util/docker_build.sh ergodox_ez:steno
136```
137이 커맨드는 원하는 키보드 또는 키맵을 컴파일하고 `.hex`또는 `.bin`파일을 프로그램 업로드를(flashing) 위해 QMK디랙토리에 생성할것입니다. 만약 `:keymap`이 생략된다면 `default`이 기본을로 사용됩니다. 참고로 여기서 사용되는 인수는 `make` 커맨드를 사용하여 컴파일할때와 동일합니다.
138
139
140또한 스크립트를 그냥 아무 인수 없이도 사용가능합니다. 그렇게 된다면 프로그램은 하나씩 자동으로 인수입력을 요구 할것입니다. 어쩌면 이방법이 더 쉬울 수도 있습니다.
141```bash
142util/docker_build.sh
143# 인수을 입력받습니다.(아무것도 쓰지 않고 놔두는면 기본값으로 설정됩니다)
144```
145
146다음과 같이 `target`를 사용하여 컴파일과 프로그램 업로드(flashing)을 동시에 할수도 있습니다.
147```bash
148util/docker_build.sh keyboard:keymap:target
149# 예: util/docker_build.sh planck/rev6:default:dfu-util
150```
151만약 당시이 리눅스를 사용한다면 이 커맨드들은 추가 설정 없이 바로 작동할 것입니다. 하지만 위도우 또는 맥 환경에서는 [Docker Machine](http://gw.tnode.com/docker/docker-machine-with-usb-support-on-windows-macos/)를 사용하여야 이 커맨드들을 사용가능합니다. Docker Machine설정은 꽤 지루하고 짜증남으로 추천하지 않고 [QMK Toolbox](https://github.com/qmk/qmk_toolbox)를 사용하는 것을 추천합니다.
152
153!> 윈도우에서 독커는 [Hyper-V](https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/enable-hyper-v)을 활성화 설정하여야 사용가능합니다. 즉, 도커는 Hyper-V를 지원하지 않는 윈도우 7, 윈도우 8, 그리고 **윈도우 10 홈**과 같은 윈도우 버전에서 사용할수 없다는 것을 의미합니다.
154
155## Vagrant
156만약 컴웨어를 사용하는데 문제가 있다면 Vagrant라는 이름의 툴을 사용해 볼 수 있습니다. 이 툴은 가상환경을 세팅해줌과 동시에 컴웨어를 사용하는데에 필요한 모든 설정을 해줄 것입니다. OLKB는 가상환경에 파일을 호스팅하지 않습니다. [Vagrant 가이드](getting_started_vagrant.md)에서 더 많은 정보를 확인할 수 있습니다.
diff --git a/docs/ko-kr/getting_started_getting_help.md b/docs/ko-kr/getting_started_getting_help.md
deleted file mode 100644
index 2ae7917a0..000000000
--- a/docs/ko-kr/getting_started_getting_help.md
+++ /dev/null
@@ -1,17 +0,0 @@
1# 도움 받기
2
3QMK에서 도움을 받는 방법은 다양합니다.
4
5**주의, 아래 링크들은 영어로 이루어져 있으며 영어 사용이 가능해야 편리하게 이용할 수 있습니다.**
6
7## 디스코드 실시간 채팅
8
9[QMK 디스코드 서버](https://discord.gg/Uq7gcHh)에서 QMK 개발자들과 실시간으로 대화를 나눌수있습니다. 이 디스코드에는 펌웨어, 툴박스, 하드웨어, 그리고 컨피겨레이터(configurator)에 관한 특별화된 채널이 운영되고 있습니다.
10
11## OLKB 서브레딧
12
13공식 QMK 포럼은 [reddit.com](https://reddit.com) 에 [/r/olkb](https://reddit.com/r/olkb)입니다.
14
15## Github 이슈
16
17[issue on GitHub](https://github.com/qmk/qmk_firmware/issues)에서 문제를 보고 할 수 있습니다. 이 링크는 문제가 오랜 시간을 필요로하거나 디버깅를 요구 할때 매우 유용합니다.
diff --git a/docs/ko-kr/getting_started_github.md b/docs/ko-kr/getting_started_github.md
deleted file mode 100644
index 4fd8fda6b..000000000
--- a/docs/ko-kr/getting_started_github.md
+++ /dev/null
@@ -1,67 +0,0 @@
1# QMK와 함께 Github를 사용하는 방법
2
3Github can be a little tricky to those that aren't familiar with it - this guide will walk through each step of forking, cloning, and submitting a pull request with QMK.
4
5Github는 자주 사용하는 사람이 아니면 좀 여려울수도 있습니다. 이 문서는 Github를 사용하는데 필요한 forking, cloning 그리고 submitting a pull request with QMK를 설명할 것입니다.
6
7?> 이 가이드는 당신이 git커맨드를 사용하는데 익숙하고 git환경을 당신의 시스템이 설치하였다는 전제하에 작성되었습니다.
8
9아래와 같이 [QMK Github 페이지](https://github.com/qmk/qmk_firmware)에서 당신은 "Fork"라고 쓰여있는 버튼을 볼 수 있습니다
10
11![Fork on Github](https://i.imgur.com/8Toomz4.jpg)
12
13만약 당신이 어느기관 소속이고, 무슨 계정을 사용할것인지 골라야 한다면 개인 계정을 사용하는 것을 추천합니다.
14"Fork"가 성공적으로 끝났다면 아래 보이는 "Clone or Download"를 눌러야 합니다.
15
16![Download from Github](https://i.imgur.com/N1NYcSz.jpg)
17
18"HTTPS"채크 했는지 확인하고 나와 있는 링크를 복사하세요.
19
20![HTTPS link](https://i.imgur.com/eGO0ohO.jpg)
21
22여기거 부터 커맨드라인을 사용합니다. 커맨드 라인에서 `git clone `을 치고 복사한 링크를 붙여넣은후 실행시키세요.
23
24```
25user@computer:~$ git clone https://github.com/whoeveryouare/qmk_firmware.git
26Cloning into 'qmk_firmware'...
27remote: Counting objects: 46625, done.
28remote: Compressing objects: 100% (2/2), done.
29remote: Total 46625 (delta 0), reused 0 (delta 0), pack-reused 46623
30Receiving objects: 100% (46625/46625), 84.47 MiB | 3.14 MiB/s, done.
31Resolving deltas: 100% (29362/29362), done.
32Checking out files: 100% (2799/2799), done.
33```
34
35당신은 이제 모든파일이 로컬시스템이 추가 되었습니다 그리고 이제 키맵을 추가하거나 컴파일, 프로그램 업로드(flashing)를 할 수 있습니다.
36모든 추가 변경을 만든 뒤에는 add, commit, and push를 사용하여 당신의 Folk에 추가 할 수 있습니다.
37
38```
39user@computer:~$ git add .
40user@computer:~$ git commit -m "adding my keymap"
41[master cccb1608] adding my keymap
42 1 file changed, 1 insertion(+)
43 create mode 100644 keyboards/planck/keymaps/mine/keymap.c
44user@computer:~$ git push
45Counting objects: 1, done.
46Delta compression using up to 4 threads.
47Compressing objects: 100% (1/1), done.
48Writing objects: 100% (1/1), 1.64 KiB | 0 bytes/s, done.
49Total 1 (delta 1), reused 0 (delta 0)
50remote: Resolving deltas: 100% (1/1), completed with 1 local objects.
51To https://github.com/whoeveryouare/qmk_firmware.git
52 + 20043e64...7da94ac5 master -> master
53```
54
55이로써 당신이 만든 모든 변경들이 당신의 Github의 Folk에 추가 되었습니다. (`https://github.com/<whoeveryouare>/qmk_firmware`)에서 확인하고 "New Pull Request"를 눌러 변경사항을 QMK에 업로드할수 있습니다.
56
57![New Pull Request](https://i.imgur.com/DxMHpJ8.jpg)
58
59이 버튼을 누르면 당신이 만든 모든 변경사항들이 보여질 것입니다. 만약 모든 변경사항이 맘에 든다면 "Create Pull Request"를 눌러 요청을 확정할수 있습니다.
60
61**요청사항이 확정된다고 변경사항이 바로 적용되는 것은 아닙니다.**
62
63![Create Pull Request](https://i.imgur.com/Ojydlaj.jpg)
64
65요청을 한뒤 QMK개발자들은 댓글로 무엇이 변경되었는지 등을 물어 볼수있지만 끝에는 매인 디랙토리로 업로드 될것입니다.
66
67**"Thanks for contributing to QMK :)"**
diff --git a/docs/pt-br/README.md b/docs/pt-br/README.md
deleted file mode 100644
index bf8ec974e..000000000
--- a/docs/pt-br/README.md
+++ /dev/null
@@ -1,30 +0,0 @@
1# Quantum Mechanical Keyboard Firmware
2
3[![Current Version](https://img.shields.io/github/tag/qmk/qmk_firmware.svg)](https://github.com/qmk/qmk_firmware/tags)
4[![Discord](https://img.shields.io/discord/440868230475677696.svg)](https://discord.gg/Uq7gcHh)
5[![Docs Status](https://img.shields.io/badge/docs-ready-orange.svg)](https://docs.qmk.fm)
6[![GitHub contributors](https://img.shields.io/github/contributors/qmk/qmk_firmware.svg)](https://github.com/qmk/qmk_firmware/pulse/monthly)
7[![GitHub forks](https://img.shields.io/github/forks/qmk/qmk_firmware.svg?style=social&label=Fork)](https://github.com/qmk/qmk_firmware/)
8
9## O que é o firmware QMK?
10QMK (*Quantum Mechanical Keyboard*) é uma comunidade de código aberto que mantém o QMK Firmware, o QMK Toolbox, qmk.fm e suas documentações. O QMK Firmware é um software embarcado ("firmware") de teclado baseado no [tmk\_keyboard](https://github.com/tmk/tmk_keyboard) com alguns recursos úteis para os controladores Atmel AVR e, mais especificamente, na [linha de produtos OLKB](https://olkb.com), o teclado [ErgoDox EZ](https://www.ergodox-ez.com) e a [linha de produtos Clueboard](https://clueboard.co/). Também foi portado para chips ARM usando o ChibiOS. Você pode usá-lo no seu próprio teclado com fio ou personalizado.
11
12## Como obter e usar o QMK
13
14Se você planeja contribuir com um _keymap_ ("mapa de teclas"), teclado ou recursos para o QMK, o jeito mais fácil é [percorrer o repositório através do GitHub](https://github.com/qmk/qmk_firmware#fork-destination-box) e clonar seu repositório localmente para fazer suas alterações, dê um _push_ nelas e abra uma [_Pull request_](https://github.com/qmk/qmk_firmware/pulls) no seu fork.
15
16Caso contrário, você pode cloná-lo diretamente com `git clone https://github.com/qmk/qmk_firmware`. Não faça o download dos arquivos zip ou tar; é necessário um repositório git para baixar os submódulos para compilar.
17
18## Como compilar
19
20Antes de compilar, você precisará [instalar um ambiente específico](getting_started_build_tools.md) para o desenvolvimento em plataforma AVR e/ou ARM; vez que isto for feito, você usará o comando `make` para criar um teclado e um mapa de teclas com a seguinte notação:
21
22 make planck/rev4:default
23
24Isso compilaria a revisão `rev4` do teclado ` planck` com o mapa de teclas `default`. Nem todos os teclados têm revisões (também chamadas de _subprojects_ ou _folders_); nesse caso, a revisão pode ser omitida:
25
26 make preonic:default
27
28## Como personalizar
29
30O QMK tem muitos [recursos](features.md) para explorar e uma boa quantidade de [documentação de referência](https://docs.qmk.fm) para explorar. A maioria dos recursos é aproveitada modificando seu [keymap](keymap.md) e alterando os [keycodes](keycodes.md).
diff --git a/docs/pt-br/_summary.md b/docs/pt-br/_summary.md
deleted file mode 100644
index e0a1b45b3..000000000
--- a/docs/pt-br/_summary.md
+++ /dev/null
@@ -1,122 +0,0 @@
1* [Complete Newbs Guide](pt-br/newbs.md)
2 * [Getting Started](pt-br/newbs_getting_started.md)
3 * [Building Your First Firmware](pt-br/newbs_building_firmware.md)
4 * [Flashing Firmware](pt-br/newbs_flashing.md)
5 * [Testing and Debugging](pt-br/newbs_testing_debugging.md)
6 * [Git Best Practices](pt-br/newbs_best_practices.md)
7 * [Learning Resources](pt-br/newbs_learn_more_resources.md)
8
9* [QMK Basics](pt-br/README.md)
10 * [QMK Introduction](pt-br/getting_started_introduction.md)
11 * [QMK CLI](pt-br/cli.md)
12 * [QMK CLI Config](pt-br/cli_configuration.md)
13 * [Contributing to QMK](pt-br/contributing.md)
14 * [How to Use GitHub](pt-br/getting_started_github.md)
15 * [Getting Help](pt-br/getting_started_getting_help.md)
16
17* [Breaking Changes](pt-br/breaking_changes.md)
18 * [2019 Aug 30](pt-br/ChangeLog/20190830.md)
19
20* [FAQ](faq.md)
21 * [General FAQ](pt-br/faq_general.md)
22 * [Build/Compile QMK](pt-br/faq_build.md)
23 * [Debugging/Troubleshooting QMK](pt-br/faq_debug.md)
24 * [Keymap](pt-br/faq_keymap.md)
25 * [Driver Installation with Zadig](pt-br/driver_installation_zadig.md)
26
27* Detailed Guides
28 * [Install Build Tools](pt-br/getting_started_build_tools.md)
29 * [Vagrant Guide](pt-br/getting_started_vagrant.md)
30 * [Build/Compile Instructions](pt-br/getting_started_make_guide.md)
31 * [Flashing Firmware](pt-br/flashing.md)
32 * [Customizing Functionality](pt-br/custom_quantum_functions.md)
33 * [Keymap Overview](pt-br/keymap.md)
34
35* [Hardware](hardware.md)
36 * [AVR Processors](pt-br/hardware_avr.md)
37 * [Drivers](pt-br/hardware_drivers.md)
38
39* Reference
40 * [Keyboard Guidelines](pt-br/hardware_keyboard_guidelines.md)
41 * [Config Options](pt-br/config_options.md)
42 * [Keycodes](pt-br/keycodes.md)
43 * [Coding Conventions - C](pt-br/coding_conventions_c.md)
44 * [Coding Conventions - Python](pt-br/coding_conventions_python.md)
45 * [Documentation Best Practices](pt-br/documentation_best_practices.md)
46 * [Documentation Templates](pt-br/documentation_templates.md)
47 * [Glossary](pt-br/reference_glossary.md)
48 * [Unit Testing](pt-br/unit_testing.md)
49 * [Useful Functions](pt-br/ref_functions.md)
50 * [Configurator Support](pt-br/reference_configurator_support.md)
51 * [info.json Format](pt-br/reference_info_json.md)
52 * [Python CLI Development](pt-br/cli_development.md)
53
54* [Features](pt-br/features.md)
55 * [Basic Keycodes](pt-br/keycodes_basic.md)
56 * [US ANSI Shifted Keys](pt-br/keycodes_us_ansi_shifted.md)
57 * [Quantum Keycodes](pt-br/quantum_keycodes.md)
58 * [Advanced Keycodes](pt-br/feature_advanced_keycodes.md)
59 * [Audio](pt-br/feature_audio.md)
60 * [Auto Shift](pt-br/feature_auto_shift.md)
61 * [Backlight](pt-br/feature_backlight.md)
62 * [Bluetooth](pt-br/feature_bluetooth.md)
63 * [Bootmagic](pt-br/feature_bootmagic.md)
64 * [Combos](pt-br/feature_combo.md)
65 * [Command](pt-br/feature_command.md)
66 * [Debounce API](pt-br/feature_debounce_type.md)
67 * [DIP Switch](pt-br/feature_dip_switch.md)
68 * [Dynamic Macros](pt-br/feature_dynamic_macros.md)
69 * [Encoders](pt-br/feature_encoders.md)
70 * [Grave Escape](pt-br/feature_grave_esc.md)
71 * [Haptic Feedback](pt-br/feature_haptic_feedback.md)
72 * [HD44780 LCD Controller](pt-br/feature_hd44780.md)
73 * [Key Lock](pt-br/feature_key_lock.md)
74 * [Layouts](pt-br/feature_layouts.md)
75 * [Leader Key](pt-br/feature_leader_key.md)
76 * [LED Matrix](pt-br/feature_led_matrix.md)
77 * [Macros](pt-br/feature_macros.md)
78 * [Mouse Keys](pt-br/feature_mouse_keys.md)
79 * [OLED Driver](pt-br/feature_oled_driver.md)
80 * [One Shot Keys](pt-br/one_shot_keys.md)
81 * [Pointing Device](pt-br/feature_pointing_device.md)
82 * [PS/2 Mouse](pt-br/feature_ps2_mouse.md)
83 * [RGB Lighting](pt-br/feature_rgblight.md)
84 * [RGB Matrix](pt-br/feature_rgb_matrix.md)
85 * [Space Cadet](pt-br/feature_space_cadet.md)
86 * [Split Keyboard](pt-br/feature_split_keyboard.md)
87 * [Stenography](pt-br/feature_stenography.md)
88 * [Swap Hands](pt-br/feature_swap_hands.md)
89 * [Tap Dance](pt-br/feature_tap_dance.md)
90 * [Terminal](pt-br/feature_terminal.md)
91 * [Thermal Printer](pt-br/feature_thermal_printer.md)
92 * [Unicode](pt-br/feature_unicode.md)
93 * [Userspace](pt-br/feature_userspace.md)
94 * [Velocikey](pt-br/feature_velocikey.md)
95
96* For Makers and Modders
97 * [Hand Wiring Guide](pt-br/hand_wire.md)
98 * [ISP Flashing Guide](pt-br/isp_flashing_guide.md)
99 * [ARM Debugging Guide](pt-br/arm_debugging.md)
100 * [I2C Driver](pt-br/i2c_driver.md)
101 * [SPI Driver](pt-br/spi_driver.md)
102 * [GPIO Controls](pt-br/internals_gpio_control.md)
103 * [Proton C Conversion](pt-br/proton_c_conversion.md)
104
105* For a Deeper Understanding
106 * [How Keyboards Work](pt-br/how_keyboards_work.md)
107 * [Understanding QMK](pt-br/understanding_qmk.md)
108
109* Other Topics
110 * [Using Eclipse with QMK](pt-br/other_eclipse.md)
111 * [Using VSCode with QMK](pt-br/other_vscode.md)
112 * [Support](pt-br/getting_started_getting_help.md)
113 * [How to add translations](pt-br/translating.md)
114
115* QMK Internals (In Progress)
116 * [Defines](pt-br/internals_defines.md)
117 * [Input Callback Reg](pt-br/internals_input_callback_reg.md)
118 * [Midi Device](pt-br/internals_midi_device.md)
119 * [Midi Device Setup Process](pt-br/internals_midi_device_setup_process.md)
120 * [Midi Util](pt-br/internals_midi_util.md)
121 * [Send Functions](pt-br/internals_send_functions.md)
122 * [Sysex Tools](pt-br/internals_sysex_tools.md)
diff --git a/docs/ru-ru/README.md b/docs/ru-ru/README.md
deleted file mode 100644
index 721878154..000000000
--- a/docs/ru-ru/README.md
+++ /dev/null
@@ -1,31 +0,0 @@
1# Quantum Mechanical Keyboard Firmware
2
3[![Current Version](https://img.shields.io/github/tag/qmk/qmk_firmware.svg)](https://github.com/qmk/qmk_firmware/tags)
4[![Discord](https://img.shields.io/discord/440868230475677696.svg)](https://discord.gg/Uq7gcHh)
5[![Docs Status](https://img.shields.io/badge/docs-ready-orange.svg)](https://docs.qmk.fm)
6[![GitHub contributors](https://img.shields.io/github/contributors/qmk/qmk_firmware.svg)](https://github.com/qmk/qmk_firmware/pulse/monthly)
7[![GitHub forks](https://img.shields.io/github/forks/qmk/qmk_firmware.svg?style=social&label=Fork)](https://github.com/qmk/qmk_firmware/)
8
9## Что такое QMK Firmware?
10
11QMK (*Quantum Mechanical Keyboard*) — это сообщество, работающее над ПО с открытым исходным кодом, которое разрабатывает QMK Firmware, QMK Toolbox, qmk.fm и эту документацию. QMK Firmware — это прошивка для клавиатур, основанная на [tmk\_keyboard](https://github.com/tmk/tmk_keyboard) с множеством полезных функций для микроконтроллеров Atmel AVR, а именно, для продуктов компаний [OLKB](https://olkb.com), [ErgoDox EZ](https://www.ergodox-ez.com) и [Clueboard](https://clueboard.co/). Она также была портирована на чипы ARM при помощи ChibiOS. Вы можете использовать ее для клавиатуры, собранной вручную или имеющей нестандартную печатную плату.
12
13## Как скачать
14
15Если вы собираетесь добавить раскладку, клавиатуру или новые функции в QMK, то самый простой путь реализации — это [сделать форк репозитория на GitHub](https://github.com/qmk/qmk_firmware#fork-destination-box), клонировать ваш репозиторий локально для дальнейшего внесения изменений, сделать пуш изменений, а затем открыть [пулреквест](https://github.com/qmk/qmk_firmware/pulls) из вашего форка.
16
17Также вы можете либо скачать репозиторий ([zip](https://github.com/qmk/qmk_firmware/zipball/master), [tar](https://github.com/qmk/qmk_firmware/tarball/master)), либо клонировать его через git (`git@github.com:qmk/qmk_firmware.git`) или https (`https://github.com/qmk/qmk_firmware.git`).
18
19## Как скомпилировать
20
21Перед компиляцией вам необходимо [настроить окружение](ru-ru/getting_started_build_tools.md) разработчика для AVR или/и ARM. После этого используйте команду `make` со следующим синтаксисом, чтобы собрать клавиатуру и раскладку:
22
23 make planck/rev4:default
24
25Данная команда соберет ревизию `rev4` клавиатуры `planck` с раскладкой `default`. Не все клавиатуры имеют ревизии (они также называются subprojects или folders), в этом случае она может быть опущена:
26
27 make preonic:default
28
29## Как настроить
30
31QMK обладает множеством [функций](ru-ru/features.md) для исследования, и [справочная документация](https://docs.qmk.fm) может стать хорошей отправной точкой для знакомства с ними. Большинством функций можно воспользоваться модифицируя [раскладку](ru-ru/keymap.md) и изменяя [коды клавиш](ru-ru/keycodes.md).
diff --git a/docs/ru-ru/_summary.md b/docs/ru-ru/_summary.md
deleted file mode 100644
index 09273172b..000000000
--- a/docs/ru-ru/_summary.md
+++ /dev/null
@@ -1,124 +0,0 @@
1* [Complete Newbs Guide](ru-ru/newbs.md)
2 * [Getting Started](ru-ru/newbs_getting_started.md)
3 * [Building Your First Firmware](ru-ru/newbs_building_firmware.md)
4 * [Flashing Firmware](ru-ru/newbs_flashing.md)
5 * [Testing and Debugging](ru-ru/newbs_testing_debugging.md)
6 * [Git Best Practices](ru-ru/newbs_best_practices.md)
7 * [Learning Resources](ru-ru/newbs_learn_more_resources.md)
8
9* [QMK Basics](ru-ru/README.md)
10 * [QMK Introduction](ru-ru/getting_started_introduction.md)
11 * [QMK CLI](ru-ru/cli.md)
12 * [QMK CLI Config](ru-ru/cli_configuration.md)
13 * [Contributing to QMK](ru-ru/contributing.md)
14 * [How to Use GitHub](ru-ru/getting_started_github.md)
15 * [Getting Help](ru-ru/getting_started_getting_help.md)
16
17* [Breaking Changes](ru-ru/breaking_changes.md)
18 * [2019 Aug 30](ru-ru/ChangeLog/20190830.md)
19
20* [FAQ](ru-ru/faq.md)
21 * [General FAQ](ru-ru/faq_general.md)
22 * [Build/Compile QMK](ru-ru/faq_build.md)
23 * [Debugging/Troubleshooting QMK](ru-ru/faq_debug.md)
24 * [Keymap](ru-ru/faq_keymap.md)
25 * [Driver Installation with Zadig](ru-ru/driver_installation_zadig.md)
26
27* Detailed Guides
28 * [Install Build Tools](ru-ru/getting_started_build_tools.md)
29 * [Vagrant Guide](ru-ru/getting_started_vagrant.md)
30 * [Build/Compile Instructions](ru-ru/getting_started_make_guide.md)
31 * [Flashing Firmware](ru-ru/flashing.md)
32 * [Customizing Functionality](ru-ru/custom_quantum_functions.md)
33 * [Keymap Overview](ru-ru/keymap.md)
34
35* [Hardware](ru-ru/hardware.md)
36 * [Compatible Microcontrollers](ru-ru/compatible_microcontrollers.md)
37 * [AVR Processors](ru-ru/hardware_avr.md)
38 * [Drivers](ru-ru/hardware_drivers.md)
39
40* Reference
41 * [Keyboard Guidelines](ru-ru/hardware_keyboard_guidelines.md)
42 * [Config Options](ru-ru/config_options.md)
43 * [Keycodes](ru-ru/keycodes.md)
44 * [Coding Conventions - C](ru-ru/coding_conventions_c.md)
45 * [Coding Conventions - Python](ru-ru/coding_conventions_python.md)
46 * [Documentation Best Practices](ru-ru/documentation_best_practices.md)
47 * [Documentation Templates](ru-ru/documentation_templates.md)
48 * [Glossary](ru-ru/reference_glossary.md)
49 * [Unit Testing](ru-ru/unit_testing.md)
50 * [Useful Functions](ru-ru/ref_functions.md)
51 * [Configurator Support](ru-ru/reference_configurator_support.md)
52 * [info.json Format](ru-ru/reference_info_json.md)
53 * [Python CLI Development](ru-ru/cli_development.md)
54
55* [Features](ru-ru/features.md)
56 * [Basic Keycodes](ru-ru/keycodes_basic.md)
57 * [US ANSI Shifted Keys](ru-ru/keycodes_us_ansi_shifted.md)
58 * [Quantum Keycodes](ru-ru/quantum_keycodes.md)
59 * [Advanced Keycodes](ru-ru/feature_advanced_keycodes.md)
60 * [Audio](ru-ru/feature_audio.md)
61 * [Auto Shift](ru-ru/feature_auto_shift.md)
62 * [Backlight](ru-ru/feature_backlight.md)
63 * [Bluetooth](ru-ru/feature_bluetooth.md)
64 * [Bootmagic](ru-ru/feature_bootmagic.md)
65 * [Combos](ru-ru/feature_combo.md)
66 * [Command](ru-ru/feature_command.md)
67 * [Debounce API](ru-ru/feature_debounce_type.md)
68 * [DIP Switch](ru-ru/feature_dip_switch.md)
69 * [Dynamic Macros](ru-ru/feature_dynamic_macros.md)
70 * [Encoders](ru-ru/feature_encoders.md)
71 * [Grave Escape](ru-ru/feature_grave_esc.md)
72 * [Haptic Feedback](ru-ru/feature_haptic_feedback.md)
73 * [HD44780 LCD Controller](ru-ru/feature_hd44780.md)
74 * [Key Lock](ru-ru/feature_key_lock.md)
75 * [Layouts](ru-ru/feature_layouts.md)
76 * [Leader Key](ru-ru/feature_leader_key.md)
77 * [LED Matrix](ru-ru/feature_led_matrix.md)
78 * [Macros](ru-ru/feature_macros.md)
79 * [Mouse Keys](ru-ru/feature_mouse_keys.md)
80 * [OLED Driver](ru-ru/feature_oled_driver.md)
81 * [One Shot Keys](ru-ru/one_shot_keys.md)
82 * [Pointing Device](ru-ru/feature_pointing_device.md)
83 * [PS/2 Mouse](ru-ru/feature_ps2_mouse.md)
84 * [RGB Lighting](ru-ru/feature_rgblight.md)
85 * [RGB Matrix](ru-ru/feature_rgb_matrix.md)
86 * [Space Cadet](ru-ru/feature_space_cadet.md)
87 * [Split Keyboard](ru-ru/feature_split_keyboard.md)
88 * [Stenography](ru-ru/feature_stenography.md)
89 * [Swap Hands](ru-ru/feature_swap_hands.md)
90 * [Tap Dance](ru-ru/feature_tap_dance.md)
91 * [Terminal](ru-ru/feature_terminal.md)
92 * [Thermal Printer](ru-ru/feature_thermal_printer.md)
93 * [Unicode](ru-ru/feature_unicode.md)
94 * [Userspace](ru-ru/feature_userspace.md)
95 * [Velocikey](ru-ru/feature_velocikey.md)
96
97* For Makers and Modders
98 * [Hand Wiring Guide](ru-ru/hand_wire.md)
99 * [ISP Flashing Guide](ru-ru/isp_flashing_guide.md)
100 * [ARM Debugging Guide](ru-ru/arm_debugging.md)
101 * [I2C Driver](ru-ru/i2c_driver.md)
102 * [SPI Driver](ru-ru/spi_driver.md)
103 * [WS2812 Driver](ru-ru/ws2812_driver.md)
104 * [GPIO Controls](ru-ru/internals_gpio_control.md)
105 * [Proton C Conversion](ru-ru/proton_c_conversion.md)
106
107* For a Deeper Understanding
108 * [How Keyboards Work](ru-ru/how_keyboards_work.md)
109 * [Understanding QMK](ru-ru/understanding_qmk.md)
110
111* Other Topics
112 * [Using Eclipse with QMK](ru-ru/other_eclipse.md)
113 * [Using VSCode with QMK](ru-ru/other_vscode.md)
114 * [Support](ru-ru/getting_started_getting_help.md)
115 * [Translating the QMK Docs](ru-ru/translating.md)
116
117* QMK Internals (In Progress)
118 * [Defines](ru-ru/internals_defines.md)
119 * [Input Callback Reg](ru-ru/internals_input_callback_reg.md)
120 * [Midi Device](ru-ru/internals_midi_device.md)
121 * [Midi Device Setup Process](ru-ru/internals_midi_device_setup_process.md)
122 * [Midi Util](ru-ru/internals_midi_util.md)
123 * [Send Functions](ru-ru/internals_send_functions.md)
124 * [Sysex Tools](ru-ru/internals_sysex_tools.md)
diff --git a/docs/ru-ru/getting_started_build_tools.md b/docs/ru-ru/getting_started_build_tools.md
deleted file mode 100644
index 322f9a9e5..000000000
--- a/docs/ru-ru/getting_started_build_tools.md
+++ /dev/null
@@ -1,153 +0,0 @@
1# Установка инструментов для сборки
2
3Данная страница описывает процесс установки окружения для сборки QMK. Эти инструкции относятся к процессорам AVR (таким как atmega32u4).
4
5<!-- FIXME: Нужно написать и добавить куда-нибудь инструкции для ARM. -->
6
7**Примечание:** Если вы здесь впервые, ознакомьтесь с [Руководством для полных новичков](ru-ru/newbs.md).
8
9Прежде, чем продолжить, убедитесь, что у вас обновлены подмодули (сторонние библиотеки), выполнив `make git-submodule`.
10
11## Linux
12
13Чтобы всегда быть уверенными, что у вас установлены последние версии ПО, можно просто выполнить команду `sudo util/qmk_install.sh`. Она должна установить все необходимые зависимости. **Это выполнит `apt-get upgrade`.**
14
15Вы также можете устанавливать все вручную, но в данной документации список требований может не всегда быть актуальным.
16
17Текущие требования представлены ниже, но не все они могут быть необходимы, так как зависят от того, что вы делаете. Также стоит отметить, что в некоторых системах не все зависимости доступны в виде пакетов, или они могут называться по-другому.
18
19```
20build-essential
21gcc
22unzip
23wget
24zip
25gcc-avr
26binutils-avr
27avr-libc
28dfu-programmer
29dfu-util
30gcc-arm-none-eabi
31binutils-arm-none-eabi
32libnewlib-arm-none-eabi
33git
34```
35
36Установите все зависимости при помощи вашего любимого менеджера пакетов.
37
38Пример для Debian / Ubuntu:
39
40 sudo apt-get update
41 sudo apt-get install gcc unzip wget zip gcc-avr binutils-avr avr-libc dfu-programmer dfu-util gcc-arm-none-eabi binutils-arm-none-eabi libnewlib-arm-none-eabi
42
43Пример для Fedora / Red Hat:
44
45 sudo dnf install gcc unzip wget zip dfu-util dfu-programmer avr-gcc avr-libc binutils-avr32-linux-gnu arm-none-eabi-gcc-cs arm-none-eabi-binutils-cs arm-none-eabi-newlib
46
47Пример для Arch / Manjaro:
48
49 pacman -S base-devel gcc unzip wget zip avr-gcc avr-binutils avr-libc dfu-util arm-none-eabi-gcc arm-none-eabi-binutils arm-none-eabi-newlib git dfu-programmer dfu-util
50
51## Nix
52
53Если вы используете [NixOS](https://nixos.org/), или у вас установлена Nix в Linux или macOS, выполните `nix-shell` из корня репозитория, чтобы настроить окружение для сборки.
54
55По умолчанию, это скачает компиляторы для AVR и ARM. Если вам не нужны они оба, отключите `avr` или `arm` с помощью аргумента, например:
56
57 nix-shell --arg arm false
58
59## macOS
60
61Если вы пользуетесь [Homebrew](https://brew.sh/), вы можете использовать следующие команды:
62
63 brew tap osx-cross/avr
64 brew tap PX4/homebrew-px4
65 brew update
66 brew install avr-gcc@8
67 brew link --force avr-gcc@8
68 brew install dfu-programmer
69 brew install dfu-util
70 brew install gcc-arm-none-eabi
71 brew install avrdude
72
73Данный метод является рекомендуемым. Если у вас нет Homebrew, [установите его!](https://brew.sh/) Он очень сильно пригодится тем, кто работает с командной строкой. Стоит отметить, что часть с `make` и `make install` во время установки `avr-gcc@8` из Homebrew может занимать более 20 минут и сильно нагружать CPU.
74
75## Windows с MSYS2 (рекомендуется)
76
77Наилучшим окружение для Windows Vista и всех последующих версий (тестировалось с 7 и 10) является [MSYS2](https://www.msys2.org).
78
79* Для установки MSYS2, скачайте его и следуйте дальнейшим указаниям отсюда: https://www.msys2.org
80* Откройте ``MSYS2 MingGW 64-bit`` ярлык
81* Перейдите в свой репозиторий QMK. Например, если он находится в корне вашего диска C:
82 * `$ cd /c/qmk_firmware`
83* Запустите `util/qmk_install.sh` и следуйте подсказкам
84
85## Windows 10 (устарело)
86
87Это устаревшие инструкции для Windows 10. Мы рекомендуем использовать [MSYS2, как сказано выше](#windows-с-msys2-рекомендуется).
88
89### Обновление для дизайнеров (Creators Update)
90
91Если у вас Windows 10 с Обновлением для дизайнеров или новее, вы можете собрать прошивку и прошить ей напрямую. До Обновления для дизайнеров было возможно только собрать прошивку. Если у вас его еще нет, или вы не уверены, следуйте [этим инструкциям](https://support.microsoft.com/en-us/instantanswers/d4efb316-79f0-1aa1-9ef3-dcada78f3fa0/get-the-windows-10-creators-update).
92
93### Подсистема Windows для Linux (Windows Subsystem for Linux, WSL)
94
95В дополнение к Обновлению для дизайнеров вам необходима подсистема Windows для Linux, поэтому установите ее, следуя [иснтрукциям здесь](https://www.howtogeek.com/249966/how-to-install-and-use-the-linux-bash-shell-on-windows-10/). Если у вас уже есть подсистема Windows для Linux из Юбилейного обновления (Anniversary update), рекомендуется ее [обновить](https://betanews.com/2017/04/14/upgrade-windows-subsystem-for-linux/) до 16.04LTS, потому что некоторые клавиатуры не компилируются с набором инструментов из 14.04LTS. Стоит отметить, что вы четко должны понимать, что вы делаете, если выбрали метод `sudo do-release-upgrade`.
96
97### Git
98
99Если вы уже клонировали репозиторий в файловую систему Windows, вы можете пропустить данную секцию.
100
101Вам нужно клонировать репозиторий в файловую систему Windows при помощи обычного Git для Windows, а **не** WSL Git. Так что, если вы ещё не установили Git, [скачайте](https://git-scm.com/download/win) и установите его. Затем [настройте его](https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup). Важно указать свой адрес электронной почты и имя пользователя, особенно если вы планируете вносить свой вклад в проект.
102
103Как только Git будет установлен, откройте командную строку Git Bash и поменяйте директорию на ту, в которую хотите клонировать QMK; обратите внимание, что вы должны использовать косую черту, и что доступ к вашему диску C осуществляется примерно так: `/c/path/to/where/you/want/to/go`. Затем выполните `git clone --recurse-submodules https://github.com/qmk/qmk_firmware`, это создаст новую папку `qmk_firmware` в текущей директории.
104
105### Установка инструментов (Toolchain)
106
107Установка инструментов (Toolchain) осуществляется через подсистему Windows для Linux, и процесс полностью автоматизирован. Если вы хотите выполнить установку вручную, то не существует никакой другой инструкции помимо самого скрипта. Однако, вы всегда можете открыть ишью и запросить дополнительную информацию.
108
1091. Откройте "Bash On Ubuntu On Windows" в меню Пуск.
1102. Перейдите в папку, в которую клонирована `qmk_firmware`. Обратите внимание, что пути начинаются с `/mnt/` в WSL, так что вы должны написать, например, `cd /mnt/c/path/to/qmk_firmware`.
1113. Запустите `util/wsl_install.sh` и следуйте инструкциям на экране.
1124. Закройте окно командной строки Bash, и откройте его снова.
1135. Все готово, чтобы скомпилировать прошивку и прошить ей!
114
115### Несколько важных вещей, которые надо запомнить
116
117* Вы можете запустить `util/wsl_install.sh` еще раз, чтобы установить все последние обновления.
118* Ваш репозиторий QMK должен находиться в файловой системе Windows, поскольку WSL не может запускать выполняемые файлы извне.
119* WSL Git **не** совместим с Windows Git, поэтому используйте Windows Git Bash или Windows Git GUI для всех операций с Git.
120* Вы можете изменять файлы как внутри WSL, так и просто через Windows. Но обратите внимание, что если вы изменяете makefiles или сценарии командной строки, вы должны убедиться, что используете текстовый редактор, который сохраняет файлы с переводом строки в стиле Unix (Unix line endings). В противном случае компиляция может не работать.
121
122## Docker
123
124Если это немного сложновато для вас, Docker может стать готовым решением, которое вы ищите. После установки [Docker CE](https://docs.docker.com/install/#supported-platforms) выполните следующую команду из директории `qmk_firmware`, чтобы собрать клавиатуру/раскладку:
125
126```bash
127util/docker_build.sh keyboard:keymap
128# Например: util/docker_build.sh ergodox_ez:steno
129```
130
131Это скомпилирует указанную клавиатуру/раскладку и создаст для вас `.hex` или `.bin` файл с результатом, готовым к процессу прошивки, в директории QMK. Если опустить `:keymap`, будет использована раскладка `default`. Заметьте, что формат параметров такой же, как и в случае сборки командой `make`.
132
133Вы также можете запустить скрипт без параметров. Тогда он попросит вас ввести поочередно параметры сборки. Возможно, вам это покажется более удобным:
134
135```bash
136util/docker_build.sh
137# Читает параметры из пользовательского ввода (оставьте пустым для значений по умолчанию)
138```
139
140Также имеется поддержка сборки _и_ прошивки клавиатуры прямо из Docker. Для этого укажите еще один параметр `target`:
141
142```bash
143util/docker_build.sh keyboard:keymap:target
144# Например: util/docker_build.sh planck/rev6:default:dfu-util
145```
146
147Если вы используете Linux, это должно работать прямо из коробки. На Windows и macOS это требует запуска [Docker Machine](http://gw.tnode.com/docker/docker-machine-with-usb-support-on-windows-macos/). Ее довольно утомительно настраивать, поэтому мы не рекомендуем это; используйте вместо этого [QMK Toolbox](https://github.com/qmk/qmk_toolbox).
148
149!> Docker для Windows требует включения [Hyper-V](https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/enable-hyper-v). Это означает, что он не работает на версиях Windows без Hyper-V, например, на Windows 7, Windows 8 и **Windows 10 Home**.
150
151## Vagrant
152
153Если у вас возникли проблемы при сборке прошивки, вы можете попробовать установить инструмент под названием Vagrant. Он сконфигурирует виртуальный компьютер с такими параметрами, которые подходят для сборки прошивки. У OLKB НЕТ файлов такого виртуально компьютера. Подробности о том, как настроить Vagrant, можно найти в [Руководстве по Vagrant](ru-ru/getting_started_vagrant.md).
diff --git a/docs/ru-ru/getting_started_getting_help.md b/docs/ru-ru/getting_started_getting_help.md
deleted file mode 100644
index 75be44310..000000000
--- a/docs/ru-ru/getting_started_getting_help.md
+++ /dev/null
@@ -1,15 +0,0 @@
1# Получение помощи
2
3Существует много ресурсов для получения помощи по работе с QMK.
4
5## Чат в реальном времени
6
7Вы можете найти разработчиков и пользователей QMK на нашем главном [сервере Discord](https://discord.gg/Uq7gcHh). На сервере есть специальные каналы для разговоров о прошивке, Toolbox, оборудовании и конфигураторе.
8
9## OLKB Сабреддит
10
11Официальный форум QMK [/r/olkb](https://reddit.com/r/olkb) на [reddit.com](https://reddit.com).
12
13## GitHub ишью
14
15Вы можете открыть [ишью на GitHub](https://github.com/qmk/qmk_firmware/issues). Это особенно удобно, когда ваша проблема потребует длительного обсуждения или отладки.
diff --git a/docs/ru-ru/getting_started_github.md b/docs/ru-ru/getting_started_github.md
deleted file mode 100644
index 7a70926f5..000000000
--- a/docs/ru-ru/getting_started_github.md
+++ /dev/null
@@ -1,63 +0,0 @@
1# Как использовать GitHub с QMK
2
3GitHub может показаться несколько сложным для тех, кто никогда с ним не работал. В данном руководстве будет разобран каждый шаг создания форка, клонирования и отправки пулреквеста в QMK.
4
5?> В этом руководстве предполагается, что вы в какой-то степени знакомы с работой в командной строке, и в вашей системе установлен git.
6
7Откройте [страницу QMK на GitHub] (https://github.com/qmk/qmk_firmware), и в правом верхнем углу вы увидите кнопку с надписью "Fork":
8
9![Fork on GitHub](https://i.imgur.com/8Toomz4.jpg)
10
11Если вы состоите в какой-либо организации, вам нужно выбрать учетную запись, к которой будет привязан форк. В большинстве случаев это будет личной аккаунт. Как только ваш форк будет завершен (иногда это занимает немного времени), нажмите кнопку "Clone or Download":
12![Download from GitHub](https://i.imgur.com/N1NYcSz.jpg)
13
14И обязательно выберите "HTTPS", затем выделите ссылку и скопируйте ее:
15
16![HTTPS link](https://i.imgur.com/eGO0ohO.jpg)
17
18Теперь введите `git clone --recurse-submodules ` в командную строку, а затем вставьте ссылку:
19
20```
21user@computer:~$ git clone --recurse-submodules https://github.com/whoeveryouare/qmk_firmware.git
22Cloning into 'qmk_firmware'...
23remote: Enumerating objects: 9, done.
24remote: Counting objects: 100% (9/9), done.
25remote: Compressing objects: 100% (5/5), done.
26remote: Total 183883 (delta 5), reused 4 (delta 4), pack-reused 183874
27Receiving objects: 100% (183883/183883), 132.90 MiB | 9.57 MiB/s, done.
28Resolving deltas: 100% (119972/119972), done.
29...
30Submodule path 'lib/chibios': checked out '587968d6cbc2b0e1c7147540872f2a67e59ca18b'
31Submodule path 'lib/chibios-contrib': checked out 'ede48346eee4b8d6847c19bc01420bee76a5e486'
32Submodule path 'lib/googletest': checked out 'ec44c6c1675c25b9827aacd08c02433cccde7780'
33Submodule path 'lib/lufa': checked out 'ce10f7642b0459e409839b23cc91498945119b4d'
34```
35
36Теперь у вас есть форк QMK на вашем локальном компьютере, и вы можете добавить свою раскладку, скомпилировать ее и прошить ей свою клавиатуру. Как только вы будете довольны своими изменениями, есть возможность добавить, зафиксировать их и сделать коммит в свой форк следующим образом:
37
38```
39user@computer:~$ git add .
40user@computer:~$ git commit -m "adding my keymap"
41[master cccb1608] adding my keymap
42 1 file changed, 1 insertion(+)
43 create mode 100644 keyboards/planck/keymaps/mine/keymap.c
44user@computer:~$ git push
45Counting objects: 1, done.
46Delta compression using up to 4 threads.
47Compressing objects: 100% (1/1), done.
48Writing objects: 100% (1/1), 1.64 KiB | 0 bytes/s, done.
49Total 1 (delta 1), reused 0 (delta 0)
50remote: Resolving deltas: 100% (1/1), completed with 1 local objects.
51To https://github.com/whoeveryouare/qmk_firmware.git
52 + 20043e64...7da94ac5 master -> master
53```
54
55Ваши изменения теперь существуют в вашем форке на GitHub - если вернуться туда (`https://github.com/<whoeveryouare>/qmk_firmware`), вы сможете создать "New Pull Request" нажатием на кнопку:
56
57![New Pull Request](https://i.imgur.com/DxMHpJ8.jpg)
58
59Здесь вы сможете увидеть, какие именно изменения были внесены, - если все выглядит хорошо, вы можете завершить его, нажав "Create Pull Request":
60
61![Create Pull Request](https://i.imgur.com/Ojydlaj.jpg)
62
63После отправки мы можем расспросить вас о ваших изменениях, попросить внести корректировки и в конечном итоге принять их! Спасибо за ваш вклад в QMK :)
diff --git a/docs/ru-ru/getting_started_introduction.md b/docs/ru-ru/getting_started_introduction.md
deleted file mode 100644
index ccc441806..000000000
--- a/docs/ru-ru/getting_started_introduction.md
+++ /dev/null
@@ -1,58 +0,0 @@
1# Введение
2
3Эта страница пытается объяснить основную информацию, которую вы должны знать, чтобы работать с проектом QMK. Предполагается, что вы знакомы с навигацией в оболочке Unix, но не предполагается, что вы знакомы с C или с компиляцией с использованием make.
4
5## Базовая структура QMK
6
7QMK - это форк [Джуна Вако (Jun Wako)](https://github.com/tmk) проекта [tmk_keyboard](https://github.com/tmk/tmk_keyboard). Оригинальный код TMK с изменениями можно найти в папке `tmk_core`. Дополнения QMK к проекту можно найти в папке `quantum`. Проекты клавиатур можно найти в папках `handwired` и `keyboard`.
8
9### Структура пространства пользователя
10
11Внутри папки `users` находится каталог для каждого пользователя. Это место для пользователей, куда они могут поместить код, чтобы использовать его с разными клавиатурами. Для получения дополнительной информации обратитесь к документации по [функциям пользовательского пространства](ru-ru/feature_userspace.md).
12
13### Структура проекта клавиатуры
14
15Внутри папки `keyboards` есть подпапки `handwired` и есть подкаталоги поставщиков и производителей, для примера, `clueboard` - это каталог для каждого проекта клавиатуры, например, `qmk_firmware/keyboards/clueboard/2x1800`. В нем вы найдете следующую структуру:
16* `keymaps/`: Различные раскладки клавиш, которые можно собрать.
17* `rules.mk`: Файл, который устанавливает параметры по умолчанию для команды "make". Не редактируйте этот файл напрямую, вместо этого используйте `rules.mk`, относящийся к конкретной раскладке.
18* `config.h`: Файл, который устанавливает параметры времени компиляции по умолчанию. Не редактируйте этот файл напрямую, вместо этого используйте `config.h`, относящийся к конкретной раскладке.
19* `info.json`: Файл настройки раскладки для QMK Configurator. Посмотрите [Поддержку конфигуратора](ru-ru/reference_configurator_support.md) для дополнительной информации.
20* `readme.md`: Краткий обзор клавиатуры.
21* `<keyboardName>.h`: В этом файле определяется раскладка клавиатуры по матрице переключателей клавиатуры.
22* `<keyboardName>.c`: В этом файле вы можете найти пользовательский код для клавиатуры.
23
24Для получения дополнительной информации о структуре проекта обратитесь к [Руководству QMK по клавиатуре](ru-ru/hardware_keyboard_guidelines.md).
25
26### Структура раскладки клавиатуры
27
28В каждой папке раскладки клавиатуры могут быть найдены следующие файлы. Обязательным является только файл `keymap.c`, и если остальные файлы не найдены, то будут выбраны параметры по умолчанию.
29
30* `config.h`: настройки вашей раскладки клавиатуры.
31* `keymap.c`: весь код вашей раскладки клавиатуры (обязателен).
32* `rules.mk`: активированные функции QMK.
33* `readme.md`: описание вашей раскладки клавиш, как ее могут использовать другие, и объяснения функций. Пожалуйста, загрузите изображения на сервис, такой как imgur.
34
35# Файл `config.h`
36
37Существует 3 возможных местоположения `config.h`:
38
39* клавиатура (`/keyboards/<keyboard>/config.h`)
40* пространство пользователя (`/users/<user>/config.h`)
41* раскладка клавиш (`/keyboards/<keyboard>/keymaps/<keymap>/config.h`)
42
43Система сборки автоматически загружает файлы конфигурации в указанном выше порядке. Если вы хотите переопределить любую настройку, заданную предыдущим `config.h`, вам сначала нужно будет включить некоторый шаблонный код для настроек, которые вы хотите изменить.
44
45```
46#pragma once
47```
48
49Затем, чтобы переопределить настройку из предыдущего файла `config.h`, вы должны сделать `#undef` и `#define` для неё снова.
50
51Код и настройка шаблона вместе выглядят так:
52```
53#pragma once
54
55// Переопределения производятся здесь!
56#undef MY_SETTING
57#define MY_SETTING 4
58```
diff --git a/docs/ru-ru/newbs.md b/docs/ru-ru/newbs.md
deleted file mode 100644
index 0e7bd6499..000000000
--- a/docs/ru-ru/newbs.md
+++ /dev/null
@@ -1,23 +0,0 @@
1# Руководство по QMK для полных новичков
2
3QMK ― это мощная прошивка с открытым исходным кодом для вашей механической клавиатуры. Вы можете использовать QMK для легкой и мощной персонализации своей клавиатуры. Люди с разным уровнем умений, от совсем новичков до крутых программистов, успешно применяли QMK, чтобы персонализировать свои клавиатуры. Данное руководство поможет вам сделать то же самое, независимо от уровня вашего мастерства.
4
5Не уверены, поддерживает ли ваша клавиатура QMK? Если это механическая клавиатура, которую вы собрали сами, шансы достаточно велики. Мы поддерживаем [большое число любительских клавиатур](https://qmk.fm/keyboards/), поэтому, даже если ваша текущая клавиатура не совместима с QMK, у вас не должно возникнуть проблем с нахождением подходящей для ваших нужд.
6
7## Обзор
8
9В данном руководстве 7 основных секций:
10
11* [Первое знакомство](ru-ru/newbs_getting_started.md)
12* [Собираем вашу первую прошивку с помощью командной строки](ru-ru/newbs_building_firmware.md)
13* [Собираем вашу первую прошивку с помощью онлайн GUI](ru-ru/newbs_building_firmware_configurator.md)
14* [Прошиваем файл прошивки](ru-ru/newbs_flashing.md)
15* [Тестируем и отлаживаем](ru-ru/newbs_testing_debugging.md)
16* [Лучшие практики по Git](ru-ru/newbs_best_practices.md)
17* [Узнайте больше на этих ресурсах](ru-ru/newbs_learn_more_resources.md)
18
19Данное руководство сосредоточено на помощи тем, кто никогда раньше не компилировал ПО. Приятие решений и рекомендации делаются с учетом именно этого. Существует много альтернативных методов для описанных процедур, и мы поддерживаем большинство из них. Если у вас есть сомнения о том, как выполнить задачу, вы можете [попросить у нас совета](ru-ru/getting_started_getting_help.md).
20
21## Дополнительные ресурсы
22
23* [Блог Томаса Баарта (Thomas Baart) об основах QMK](https://thomasbaart.nl/category/mechanical-keyboards/firmware/qmk/qmk-basics/) – Созданный пользователем блог, охватывающий основы использования QMK Firmware с точки зрения нового пользователя.
diff --git a/docs/ru-ru/newbs_getting_started.md b/docs/ru-ru/newbs_getting_started.md
deleted file mode 100644
index a301e9adb..000000000
--- a/docs/ru-ru/newbs_getting_started.md
+++ /dev/null
@@ -1,102 +0,0 @@
1# Введение
2
3У вашей компьютерной клавиатуры внутри есть процессор, похожий на тот, что внутри вашего компьютера. Этот процессор выполняет программное обеспечение, которое отвечает за обнаружение нажатий клавиш и отсылку сигналов состояния клавиатуры, когда клавиши нажимаются и отпускаются. Роль такого ПО выполняет QMK, детектируя нажатия клавиш и отсылая эту информацию главному компьютеру. Сбор собственной раскладки эквивалентен сборке выполняемой программы для вашей клавиатуры.
4
5QMK старается дать вам большую силу, оставляя простые вещи легкими и делай сложные — возможными. Вам не надо уметь программировать, чтобы создавать мощные прошивки — вам только надо следовать нескольким простым синтаксическим правилам.
6
7# Первое знакомство
8
9Перед тем, как вы сможете собирать раскладки, вам необходимо установить некоторое программное обеспечение и настроить ваше окружение для сборки. Это нужно сделать только один раз, вне зависимости от того, для скольких клавиатур вы планируете компилировать прошивки.
10
11Если вы предпочитаете графический пользовательский интерфейс, пожалуйста, рассмотрите возможность использования онлайн [QMK Конфигуратора](https://config.qmk.fm). Пожалуйста, обратитесь к [Собираем вашу первую прошивку с помощью онлайн GUI](ru-ru/newbs_building_firmware_configurator.md).
12
13
14## Загрузка ПО
15
16### Текстовый редактор
17
18Вам понадобится программа, умеющая редактировать и сохранять **обычные текстовые** файлы. Если вы используете Windows, вы можете делать это Блокнотом, а в Linux вы можете использовать gedit. Обе программы являются простыми, но функциональными редакторами. В macOS остерегайтесь стандартного приложения TextEdit: он не будет сохранять обычные текстовые файлы, пока вы явно не выберите _Make Plain Text_ из меню _Format_.
19
20Вы также можете скачать и установить отдельный текстовый редактор наподобие [Sublime Text](https://www.sublimetext.com/) или [VS Code](https://code.visualstudio.com/). Возможно, это наилучший вариант независимо от платформы, поскольку эти программы сделаны специально для редактирования кода.
21
22?> Не уверены, какой выбрать текстовый редактор? Лоуренс Брэдфорд (Laurence Bradford) написал [отличное введение](https://learntocodewith.me/programming/basics/text-editors/) в тему.
23
24### QMK Toolbox
25
26QMK Toolbox является дополнительной графической программой для Windows и macOS, которая позволяет вам разрабатывать и отлаживать вашу клавиатуру. Вы, вероятно, посчитаете ее бесценной для легкого процесса прошивки вашей клавиатуры и просмотра отладочных сообщений, которые она отображает.
27
28[Скачайте последний выпуск здесь.](https://github.com/qmk/qmk_toolbox/releases/latest)
29
30* Для Windows: `qmk_toolbox.exe` (переносимое приложение) или `qmk_toolbox_install.exe` (установщик)
31* Для macOS: `QMK.Toolbox.app.zip` (переносимое приложение) или `QMK.Toolbox.pkg` (установщик)
32
33## Настройте ваше окружение
34
35Мы постарались сделать установку QMK максимально легкой. Вам нужно только подготовить ваше Linux или Unix окружение, после этого позвольте QMK установить все остальное.
36
37?> Если вы никогда раньше не работали с командной строкой Linux/Unix, существует несколько базовых концептов и команд, которые необходимо выучить. Эти ресурсы дадут вам достаточно знаний, чтобы работать с QMK:<br>
38[Обязательные к изучению команды Linux](https://www.guru99.com/must-know-linux-commands.html)<br>
39[Несколько базовых команд Unix](https://www.tjhsst.edu/~dhyatt/superap/unixcmd.html)
40
41### Windows
42
43Вам нужно будет установить MSYS2 и Git.
44
45* Следуйте инструкциям по установки на [домашней странице MSYS2](https://www.msys2.org).
46* Закройте все открытые терминалы MSYS2 и откройте новый терминал MSYS2 MinGW 64-bit.
47* Установите Git, выполнив эту команду: `pacman -S git`.
48
49### macOS
50
51Вам нужно будет установить Homebrew. Следуйте инструкциям на [домашней странице Homebrew](https://brew.sh).
52
53После установки Homebrew продолжите чтение с _Установите QMK_. На этом шаге вам надо будет запустить скрипт, который установит остальные пакеты.
54
55### Linux
56
57Вам нужно будет установить Git. Скорее всего, он у вас уже есть, но если нет, одна из следующих команд должна установить его:
58
59* Debian / Ubuntu / Devuan: `apt-get install git`
60* Fedora / Red Hat / CentOS: `yum install git`
61* Arch: `pacman -S git`
62
63?> Docker также является вариантом для всех платформ. [Нажмите сюда для получения подробностей.](ru-ru/getting_started_build_tools.md#docker)
64
65## Установите QMK
66
67Как только вы настроили ваше Linux/Unix окружение, вы готовы к загрузке QMK. Мы сделаем это при помощи Git, "клонировав" репозиторий QMK. Откройте Терминал или окно MSYS2 MinGW и оставьте его открытым до конца данного руководства. Выполните эти команды внутри него:
68
69```shell
70git clone --recurse-submodules https://github.com/qmk/qmk_firmware.git
71cd qmk_firmware
72```
73
74?> Если вы уже знаете, [как пользоваться GitHub](ru-ru/getting_started_github.md), мы рекомендуем вам вместо этого создать и клонировать свой собственный форк. Если вы не понимаете, что это значит, просто проигнорируйте это сообщение.
75
76QMK включает в себя скрипт, который поможет вам установить все оставшееся, что вам понадобится. Вы должны запустить его, набрав эту команду:
77
78 util/qmk_install.sh
79
80## Протестируйте ваше окружение для сборки
81
82Теперь, когда ваше окружение QMK для сборки настроено, вы можете собрать прошивку для вашей клавиатуры. Начните с попытки собрать раскладку для клавиатуры по умолчанию. У вас должно это получиться с помощью команды в этом формате:
83
84 make <keyboard>:default
85
86Например, чтобы собрать прошивку для Clueboard 66%, вы введете:
87
88 make clueboard/66/rev3:default
89
90Когда все закончится, вы должны увидеть большой лог, который заканчивается примерно так:
91
92```
93Linking: .build/clueboard_66_rev3_default.elf [OK]
94Creating load file for flashing: .build/clueboard_66_rev3_default.hex [OK]
95Copying clueboard_66_rev3_default.hex to qmk_firmware folder [OK]
96Checking file size of clueboard_66_rev3_default.hex [OK]
97 * The firmware size is fine - 26356/28672 (2316 bytes free)
98```
99
100# Создаем вашу раскладку
101
102Теперь вы готовы создать свою персональную раскладку! Для этого перейдите к [Собираем вашу первую прошивку](ru-ru/newbs_building_firmware.md).