diff options
| author | Joel Challis <git@zvecr.com> | 2022-01-05 02:11:24 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-01-04 18:11:24 -0800 |
| commit | 1c1e6fa47df8d1dc094973929afdfd1ca9333150 (patch) | |
| tree | be5134db191f468f899d6c42ad5380c050ccc16c /docs | |
| parent | 550c9a315f146bc30fc828726d977f3f41477d52 (diff) | |
Remove stale docs translations (#15737)
Diffstat (limited to 'docs')
77 files changed, 0 insertions, 6622 deletions
diff --git a/docs/_langs.md b/docs/_langs.md index e25458bbfd..8b08c34513 100644 --- a/docs/_langs.md +++ b/docs/_langs.md @@ -1,9 +1,4 @@ - Translations - [:uk: English](/) - [:cn: 简体中文](/zh-cn/) - - [:es: Español](/es/) - - [:fr: Français](/fr-fr/) - - [:israel: עברית](/he-il/) - - [:brazil: Português](/pt-br/) - - [:ru: Русский](/ru-ru/) - [:jp: 日本語](/ja/) diff --git a/docs/de/README.md b/docs/de/README.md deleted file mode 100644 index f5f35d9d1c..0000000000 --- a/docs/de/README.md +++ /dev/null @@ -1,32 +0,0 @@ -# Quantum Mechanical Keyboard Firmware - -[](https://github.com/qmk/qmk_firmware/tags) -[](https://discord.gg/Uq7gcHh) -[](https://docs.qmk.fm) -[](https://github.com/qmk/qmk_firmware/pulse/monthly) -[](https://github.com/qmk/qmk_firmware/) - -## Was ist QMK Firmware? - -QMK (*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. - -## Bezugsquelle für QMK - -Wenn 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. - -Ansonsten 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`). - - -## Anleitung fürs Kompilieren - -Bevor 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: - - make planck/rev4:default - -Dies 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: - - make preonic:default - -## Möglichkeiten der Anpassung - -QMK 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 ffbd292bd4..0000000000 --- a/docs/de/_summary.md +++ /dev/null @@ -1,122 +0,0 @@ -* [Anleitung für Anfänger](de/newbs.md) - * [Erste Schritte](de/newbs_getting_started.md) - * [Die erste Firmware](de/newbs_building_firmware.md) - * [Firmware flashen](de/newbs_flashing.md) - * [Testen und Debuggen](de/newbs_testing_debugging.md) - * [Git Tips und Tricks](de/newbs_best_practices.md) - * [Hilfreiche Ressourcen](de/newbs_learn_more_resources.md) - -* [QMK Basics](de/README.md) - * [QMK Einführung](de/getting_started_introduction.md) - * [QMK CLI](de/cli.md) - * [QMK CLI Konfiguration](de/cli_configuration.md) - * [Zu QMK beitragen](de/contributing.md) - * [Anleitung für GitHub](de/getting_started_github.md) - * [Nach Hilfe fragen](de/getting_started_getting_help.md) - -* [Breaking Changes](de/breaking_changes.md) - * [2019 Aug 30](de/ChangeLog/20190830.md) - -* [FAQ](de/faq.md) - * [Häufige Fragen](de/faq_general.md) - * [Build/Kompilieren](de/faq_build.md) - * [Debugging/Troubleshooting](de/faq_debug.md) - * [Keymap](de/faq_keymap.md) - * [Treiber Installation mit Zadig](de/driver_installation_zadig.md) - -* Detailierte Guides - * [Build Tools installieren](de/getting_started_build_tools.md) - * [Vagrant Guide](de/getting_started_vagrant.md) - * [Build/Compile Anleitung](de/getting_started_make_guide.md) - * [Firmware flashen](de/flashing.md) - * [Funktionalität anpassen](de/custom_quantum_functions.md) - * [Keymap Überblick](de/keymap.md) - -* [Hardware](de/hardware.md) - * [AVR Prozessoren](de/hardware_avr.md) - * [Treiber](de/hardware_drivers.md) - -* Referenz - * [Tastatur Richtlinien](de/hardware_keyboard_guidelines.md) - * [Konfigurations Optionen](de/config_options.md) - * [Keycodes](de/keycodes.md) - * [Coding Konventionen - C](de/coding_conventions_c.md) - * [Coding Konventionen - Python](de/coding_conventions_python.md) - * [Dokumentations Best Practices](de/documentation_best_practices.md) - * [Dokumentations Templates](de/documentation_templates.md) - * [Glossar](de/reference_glossary.md) - * [Unit Testing](de/unit_testing.md) - * [Nützliche Funktionen](de/ref_functions.md) - * [Configurator Support](de/reference_configurator_support.md) - * [info.json Format](de/reference_info_json.md) - * [Python CLI Development](de/cli_development.md) - -* [Features](de/features.md) - * [Basic Keycodes](de/keycodes_basic.md) - * [US ANSI Shifted Keys](de/keycodes_us_ansi_shifted.md) - * [Quantum Keycodes](de/quantum_keycodes.md) - * [Advanced Keycodes](de/feature_advanced_keycodes.md) - * [Audio](de/feature_audio.md) - * [Auto Shift](de/feature_auto_shift.md) - * [Backlight](de/feature_backlight.md) - * [Bluetooth](de/feature_bluetooth.md) - * [Bootmagic](de/feature_bootmagic.md) - * [Combos](de/feature_combo.md) - * [Command](de/feature_command.md) - * [Debounce API](de/feature_debounce_type.md) - * [DIP Switch](de/feature_dip_switch.md) - * [Dynamic Macros](de/feature_dynamic_macros.md) - * [Encoders](de/feature_encoders.md) - * [Grave Escape](de/feature_grave_esc.md) - * [Haptic Feedback](de/feature_haptic_feedback.md) - * [HD44780 LCD Controller](de/feature_hd44780.md) - * [Key Lock](de/feature_key_lock.md) - * [Layouts](de/feature_layouts.md) - * [Leader Key](de/feature_leader_key.md) - * [LED Matrix](de/feature_led_matrix.md) - * [Macros](de/feature_macros.md) - * [Mouse Keys](de/feature_mouse_keys.md) - * [OLED Driver](de/feature_oled_driver.md) - * [One Shot Keys](de/one_shot_keys.md) - * [Pointing Device](de/feature_pointing_device.md) - * [PS/2 Mouse](de/feature_ps2_mouse.md) - * [RGB Lighting](de/feature_rgblight.md) - * [RGB Matrix](de/feature_rgb_matrix.md) - * [Space Cadet](de/feature_space_cadet.md) - * [Split Keyboard](de/feature_split_keyboard.md) - * [Stenography](de/feature_stenography.md) - * [Swap Hands](de/feature_swap_hands.md) - * [Tap Dance](de/feature_tap_dance.md) - * [Terminal](de/feature_terminal.md) - * [Thermal Printer](de/feature_thermal_printer.md) - * [Unicode](de/feature_unicode.md) - * [Userspace](de/feature_userspace.md) - * [Velocikey](de/feature_velocikey.md) - -* Für Maker und Modder - * [Hand Wiring Guide](de/hand_wire.md) - * [ISP Flashing Guide](de/isp_flashing_guide.md) - * [ARM Debugging Guide](de/arm_debugging.md) - * [I2C Driver](de/i2c_driver.md) - * [SPI Driver](de/spi_driver.md) - * [GPIO Controls](de/internals_gpio_control.md) - * [Proton C Conversion](de/proton_c_conversion.md) - -* Für ein tieferes Verständnis - * [Wie Tastaturen funktionieren](de/how_keyboards_work.md) - * [QMK verstehen](de/understanding_qmk.md) - -* Andere Themen - * [Eclipse mit QMK](de/other_eclipse.md) - * [VSCode mit QMK](de/other_vscode.md) - * [Support](de/getting_started_getting_help.md) - * [Übersetzungen](de/translating.md) - -* QMK Internals (In Progress) - * [Defines](de/internals_defines.md) - * [Input Callback Reg](de/internals_input_callback_reg.md) - * [Midi Device](de/internals_midi_device.md) - * [Midi Device Setup Process](de/internals_midi_device_setup_process.md) - * [Midi Util](de/internals_midi_util.md) - * [Send Functions](de/internals_send_functions.md) - * [Sysex Tools](de/internals_sysex_tools.md) diff --git a/docs/de/cli.md b/docs/de/cli.md deleted file mode 100644 index 259aeecf75..0000000000 --- a/docs/de/cli.md +++ /dev/null @@ -1,150 +0,0 @@ -# QMK CLI (Kommandozeile) - -Diese Seite beschreibt die Einrichtung und den Umgang mit dem QMK CLI (Kommandozeile). - -# Übersicht - -Die 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. - -* [Globale CLI](#globale-cli) -* [Lokale CLI](#lokale-cli) -* [CLI-Befehle](#cli-befehle) - -# System-Anforderungen - -Die 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. - -# Globale CLI - -QMK 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. - -## Installation mit Homebrew (macOS, manche Linux) - -Solltest Du [Homebrew](https://brew.sh) installiert haben, kannst Du QMK per tap installieren: - -``` -brew tap qmk/qmk -brew install qmk -export QMK_HOME='~/qmk_firmware' # Optional: setzt den Installationsort für `qmk_firmware` -qmk setup # Dies klont `qmk/qmk_firmware` und richtet optional auch Deine Build-Umgebung ein -``` - -## Installation mit easy_install oder pip - -Falls 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: - -``` -pip3 install qmk -export QMK_HOME='~/qmk_firmware' # Optional: setzt den Installationsort für `qmk_firmware` -qmk setup # Dies klont `qmk/qmk_firmware` und richtet optional auch Deine Build-Umgebung ein -``` -## Installation mit git Repo - -`git clone https://github.com/qmk/qmk_cli.git && cd qmk_cli && python3 setup.py install` - -## Packaging für andere Betriebssysteme - -Wir 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: - -* Verwende "Best Practices" für Dein OS, sollten sie mit diesen Richtlinien in Konflikt stehen. - * Dokumentiere den Grund in einem Kommentar, wenn Du abweichen musstest. -* Installiere mit einem [virtualenv](https://virtualenv.pypa.io/en/latest/). -* Weise den User an, die Umgebungs-Variable `QMK_HOME` zu setzen, um die Firmware-Quelle anders einzustellen als `~/qmk_firmware`. - -# CLI-Befehle - -## `qmk compile` - -Dieser 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. - -**Anwendung für Konfigurations-Exports**: - -``` -qmk compile <configuratorExport.json> -``` - -**Anwendung für Keymaps**: - -``` -qmk compile -kb <keyboard_name> -km <keymap_name> -``` - -## `qmk format-c` - -Dieser 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. - -**Anwendung**: - -``` -qmk format-c [file1] [file2] [...] [fileN] -``` - -## `qmk config` - -Dieser Befehl konfiguriert das Verhalten von QMK. Für die volle `qmk config`-Dokumentation gehe zu [CLI-Konfiguration](cli_configuration.md). - -**Anwendung**: - -``` -qmk config [-ro] [config_token1] [config_token2] [...] [config_tokenN] -``` - -## `qmk docs` - -Dieser Befehl startet einen lokalen HTTP-Server, den Du zum Browsen oder Verbessern der Dokumentation verwenden kannst. Der Default-Port ist 8936. - -**Anwendung**: - -``` -qmk docs [-p PORT] -``` - -## `qmk doctor` - -Dieser Befehl untersucht Deine Umgebung und warnt Dich vor potentiellen Build- oder Flash-Problemen. - -**Anwendung**: - -``` -qmk doctor -``` - -## `qmk list-keyboards` - -Dieser Befehl listet alle zurzeit in `qmk_firmware` definierten Tastaturen/Keyboards auf. - -**Anwendung**: - -``` -qmk list-keyboards -``` - -## `qmk new-keymap` - -Dieser Befehl erstellt eine neue Keymap basierend auf einer existierenden Standard-Keymap eines bestimmten Keyboards. - -**Anwendung**: - -``` -qmk new-keymap [-kb KEYBOARD] [-km KEYMAP] -``` - -## `qmk format-py` - -Dieser Befehl formatiert Python-Code in `qmk_firmware`. - -**Anwendung**: - -``` -qmk format-py -``` - -## `qmk pytest` - -Dieser Befehl führt die Python Test Suite aus. Wenn Du Python-Code veränderst, solltest Du sicherstellen, dass der Test erfolgreich ausgeführt wurde. - -**Anwendung**: - -``` -qmk pytest -``` diff --git a/docs/de/driver_installation_zadig.md b/docs/de/driver_installation_zadig.md deleted file mode 100644 index bd04e05430..0000000000 --- a/docs/de/driver_installation_zadig.md +++ /dev/null @@ -1,47 +0,0 @@ -# Bootloader Treiber Installation mit Zadig - -QMK 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. - -Hierzu 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. - -Wir 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. - -## Installation - -Versetze 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. - -Eingie 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. - -Um ein Gerät mit USBaspLoader in den Bootloader-Modus zu versetzen, halte `BOOT` gedrückt während Du den `RESET`-Knopf drückst. -Alternativ, halte `BOOT` gedrückt während Du das USB-Kabel einsteckst. - -Zadig sollte das Bootloader-Gerät automatisch erkennen. Manchmal musst Du zusätzlich noch **Options → List All Devices** auswählen. - - - Tastaturen mit Atmel AVR MCUs sollten als `ATm32U4DFU` (oder ähnlich) angezeigt werden, mit der Vendor ID `03EB`. - - USBasp werden als `USBasp` angezeigt, mit VID/PID `16C0:05DC`. - - Tastaturen AVR controller und dem QMK-DFU Bootloader haben den namen `<Tastatur Name> Bootloader` und die VID `03EB`. - - Die meisten ARM Tastaturen werden als `STM32 BOOTLOADER` angezeigt, mit VID/PID `0483:DF11`. - -!> 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**! - -Wenn 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. - - - -Entferne 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. - -## Wiederherstellung einer Installation für ein falsches Gerät - -Wenn 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 . - - - -Öffne den Geräte-Manager und suche nach einem Gerät das wie deine Tastatur aussieht. - - - -Rechtsklick und **Gerät deinstallieren** anklicken. Bitte gehe sicher dass in diesem Schritt auch **Treibersoftware für dieses Gerät löschen** markiert ist. - - - -Klick **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 61139a99e1..0000000000 --- a/docs/de/newbs.md +++ /dev/null @@ -1,22 +0,0 @@ -# Anleitung für absolute Beginner -QMK 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. - -Bist 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. - -## Übersicht - -Diese Anleitung ist in 7 Abschnitte unterteilt: - -* [Die ersten Schritte](newbs_getting_started.md) -* [Die erste Firmware auf der Kommandozeile erzeugen](newbs_building_firmware.md) -* [Die erste Firmware mit der Online GUI erzeugen](newbs_building_firmware_configurator.md) -* [Firmware flashen](newbs_flashing.md) -* [Testen und Debuggen](newbs_testing_debugging.md) -* [Git Leitfaden](newbs_best_practices.md) -* [Weitere hilfreiche Ressourcen für Anfänger](newbs_learn_more_resources.md) - -Diese 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). - -## Weitere Ressourcen - -* [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 b6d4840249..0000000000 --- a/docs/de/newbs_building_firmware.md +++ /dev/null @@ -1,78 +0,0 @@ -# Eine eigene Firmware erstellen - -Nachdem 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. - -Solltest Du die Befehlszeile zwischenzeitlich geschlossen haben, vergiss nicht wieder in das richtige Verzeichnis zu navigieren, benutze dazu den Befehl `cd qmk_firmware`. - -## Navigiere in deinen Keymap Ordner - -Beginne damit, in das `keymaps` Verzeichnis für deine Tastatur zu navigieren. - -Wenn Du macOS oder Windows benutzt, kannst Du einfach in das keymaps Verzeichnis wechseln. - -?> macOS:<br> - open keyboards/<keyboard_folder>/keymaps - -?> Windows:<br> - start .\\keyboards\\<keyboard_folder>\\keymaps - -## Eine Kopie der `default` Tastaturbelegung erstellen - -Wenn 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. - -Um den Prozess zu automatisieren kannst Du dazu auch das Skript `new_keymap.sh` verwenden. - -Navigiere dazu in das `qmk_firmware/util` Verzeichnis und gib folgenden Befehl ein: - -``` -./new_keymap.sh <keyboard path> <username> -``` - -Um zum Beispiel den Benutzernamen John für die Tastaturbelegung eines 1up60hse zu verwenden, würdest Du Folgendes eingeben: - -``` -./new_keymap.sh 1upkeyboards/1up60hse john -``` - -## Öffne `keymap.c` in deinem bevorzugtem Text Editor - -Ö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: - - const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { - -Diese 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. - -!> 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. - -## Personalisiere die Tastaturbelegung nach deinen Wünschen - -Wie 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: - -* [Keycodes](de/keycodes.md) -* [Features](de/features.md) -* [FAQ](de/faq.md) - -?> 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. - -## Deine Firmware erzeugen - -Wenn Du damit fertig bist, deine Tastaturbelegung anzupassen, musst Du noch die Firmware erzeugen. Öffne dazu wieder die Befehlszeile und führe folgenden Befehl aus: - - make <my_keyboard>:<my_keymap> - -Wenn deine Tastaturbelegung z.B. "xyverz" heißt und Du die Belegung für ein rev5 planck erzeugen möchtest, lautet der Befehl: - - make planck/rev5:xyverz - -Während des Kompiliervorgangs wird viel Text auf dem Bildschirm ausgegeben. Es sollte am Ende mit etwas enden das ungefähr so aussieht: - -``` -Linking: .build/planck_rev5_xyverz.elf [OK] -Creating load file for flashing: .build/planck_rev5_xyverz.hex [OK] -Copying planck_rev5_xyverz.hex to qmk_firmware folder [OK] -Checking file size of planck_rev5_xyverz.hex [OK] - * File size is fine - 18392/28672 -``` - -## Deine Firmware flashen -Bitte 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 940438669e..0000000000 --- a/docs/de/newbs_flashing.md +++ /dev/null @@ -1,369 +0,0 @@ -# Deine Tastatur flashen - -Nachdem deine Firmware nun fertig ist musst Du Sie noch auf deine Tastatur flashen. - -## Flash-Vorgang mit QMK Toolbox - -Der einfachste Weg deine Tastatur zu flashen ist mit Hilfe der [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases) - -Leider 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. - -### Lade die Datei in QMK Toolbox - -Beginne 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. - -?> Wenn Du Windows oder macOS benutzt kannst Du mit folgenden Befehlen ganz einfach das aktuelle Firmware-Verzeichnis im Explorer oder Finder öffnen. - -#### Windows: - -``` start . ``` - -#### macOS: - -``` open . ``` - -Die Firmware-Dateien folgen dabei immer folgendem Schema: - - <meine_Tastatur>_<meine_Tastaturbelegung>.{bin,hex} - -Zum Beispiel würde ein `planck/rev5` mit der `default` Tastaturbelegung folgenden Dateinamen haben: - - planck_rev5_default.hex - -Wenn 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. - -### Die Tastatur in den DFU (Bootloader) Modus versetzen - -Um 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. - -Verschiedene 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: - -* Halte beide Shift-Tasten und drücke `Pause` -* Halte beide Shift-Tasten und drücke `B` -* 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. -* Drücke den physischen `RESET`-Knopf auf der Unterseite des PCBs -* Suche auf dem PCB den Pin mit dem Label `RESET`, verbinde diesen mit deinem GND-Pin -* 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!! - -Wenn Du damit erfolgreich warst solltest Du in der QMK Toolbox eine Nachricht sehen die ungefähr so aussieht: - -``` -*** Clueboard - Clueboard 66% HotSwap disconnected -- 0xC1ED:0x2390 -*** DFU device connected -``` - -### Tastatur flashen - -Klicke auf den `Flash`-Knopf in der QMK Toolbox. Die Ausgabe wird ungefähr so aussehen: - -``` -*** Clueboard - Clueboard 66% HotSwap disconnected -- 0xC1ED:0x2390 -*** DFU device connected -*** Attempting to flash, please don't remove device ->>> dfu-programmer atmega32u4 erase --force - Erasing flash... Success - Checking memory from 0x0 to 0x6FFF... Empty. ->>> dfu-programmer atmega32u4 flash qmk_firmware/clueboard_66_hotswap_skully.hex - Checking memory from 0x0 to 0x55FF... Empty. - 0% 100% Programming 0x5600 bytes... - [>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>] Success - 0% 100% Reading 0x7000 bytes... - [>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>] Success - Validating... Success - 0x5600 bytes written into 0x7000 bytes memory (76.79%). ->>> dfu-programmer atmega32u4 reset - -*** DFU device disconnected -*** Clueboard - Clueboard 66% HotSwap connected -- 0xC1ED:0x2390 -``` - -## Tastatur mit der Befehlszeile flashen - -Zunächst solltest Du versuchen herauszufinden welchen Bootlader deine Tastatur benutzt. Diese vier Bootloader sind am Weitesten verbreitet: - -| MCU | Bootloader | -| --- | --- | -| Pro-Micro und Klone | CATERINA | -| Teensy | Halfkay | -| OLKB Boards | QMK-DFU | -| sonstige atmega32u4 | DFU | - -Auf der Seite [Flash Anleitung und Bootloader Informationen](de/flashing.md) kannst Du mehr über das Thema erfahren. - -Wenn 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. -```rules.mk -... -BOOTLOADER = caterina -... -``` - -### DFU - -Wenn 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: - - make <meine_Tastatur>:<meine_Tastaturbelegung>:dfu - -Wenn deine Tastaturbelegung z.B den Namen "xzverz" trägt und Du ein rev5 planck flashen möchtest sähe der Befehl wie folgt aus: - - make planck/rev5:xyverz:dfu - - -Nachdem der Vorgang abgeschlossen ist sollte die Ausgabe ungefähr so aussehen: - -``` -Linking: .build/planck_rev5_xyverz.elf [OK] -Creating load file for flashing: .build/planck_rev5_xyverz.hex [OK] -Copying planck_rev5_xyverz.hex to qmk_firmware folder [OK] -Checking file size of planck_rev5_xyverz.hex - * File size is fine - 18574/28672 - ``` - -Wenn 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. - - dfu-programmer: no device present. - Error: Bootloader not found. Trying again in 5s. - -Wenn 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: - -``` -*** Attempting to flash, please don't remove device ->>> dfu-programmer atmega32u4 erase --force - Erasing flash... Success - Checking memory from 0x0 to 0x6FFF... Empty. ->>> dfu-programmer atmega32u4 flash qmk_firmware/clueboard_66_hotswap_skully.hex - Checking memory from 0x0 to 0x55FF... Empty. - 0% 100% Programming 0x5600 bytes... - [>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>] Success - 0% 100% Reading 0x7000 bytes... - [>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>] Success - Validating... Success - 0x5600 bytes written into 0x7000 bytes memory (76.79%). ->>> dfu-programmer atmega32u4 reset -``` - -?> 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). - -#### DFU Befehle - -Es gibt verschiedene DFU Befehle um die Firmware auf ein DFU Gerät zu flashen: - -* `: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. -* `:dfu-ee` - Der Flash-Vorgang benutzt eine `.eep` Datei anstatt einer `.hex` Datei. Dies ist eher unüblich. -* `: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._ -* `: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._ - - -### Caterina -Fü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: - - make <meine_Tastatur>:<meine_Tastaturbelegung>:avrdude - -Wenn 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: - - make lets_split/rev2:xyverz:avrdude - -Nachdem die Kompilation abgeschlossen ist sollte die Ausgabe ungefähr so aussehen: - -``` -Linking: .build/lets_split_rev2_xyverz.elf [OK] -Creating load file for flashing: .build/lets_split_rev2_xyverz.hex [OK] -Checking file size of lets_split_rev2_xyverz.hex [OK] - * File size is fine - 27938/28672 -Detecting USB port, reset your controller now.............. -``` - -Nun 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: - -``` -Detected controller on USB port at /dev/ttyS15 - -Connecting to programmer: . -Found programmer: Id = "CATERIN"; type = S - Software Version = 1.0; No Hardware Version given. -Programmer supports auto addr increment. -Programmer supports buffered memory access with buffersize=128 bytes. - -Programmer supports the following devices: - Device code: 0x44 - -avrdude.exe: AVR device initialized and ready to accept instructions - -Reading | ################################################## | 100% 0.00s - -avrdude.exe: Device signature = 0x1e9587 (probably m32u4) -avrdude.exe: NOTE: "flash" memory has been specified, an erase cycle will be performed - To disable this feature, specify the -D option. -avrdude.exe: erasing chip -avrdude.exe: reading input file "./.build/lets_split_rev2_xyverz.hex" -avrdude.exe: input file ./.build/lets_split_rev2_xyverz.hex auto detected as Intel Hex -avrdude.exe: writing flash (27938 bytes): - -Writing | ################################################## | 100% 2.40s - -avrdude.exe: 27938 bytes of flash written -avrdude.exe: verifying flash memory against ./.build/lets_split_rev2_xyverz.hex: -avrdude.exe: load data flash data from input file ./.build/lets_split_rev2_xyverz.hex: -avrdude.exe: input file ./.build/lets_split_rev2_xyverz.hex auto detected as Intel Hex -avrdude.exe: input file ./.build/lets_split_rev2_xyverz.hex contains 27938 bytes -avrdude.exe: reading on-chip flash data: - -Reading | ################################################## | 100% 0.43s - -avrdude.exe: verifying ... -avrdude.exe: 27938 bytes of flash verified - -avrdude.exe: safemode: Fuses OK (E:CB, H:D8, L:FF) - -avrdude.exe done. Thank you. -``` -Sollten dabei Probleme auftreten (z.B. "Zugriff verweigert" / "Permission denied") muss der Make-Befehl mit privilegierten Berechtigungen ausgeführt werden: - - sudo make <meine_Tastatur>:<meine_Tastaturbelegung>:avrdude - -Zusätzlich ist es möglich mehrere Tastaturen in einem Vorgang zu flashen: - - make <keyboard>:<keymap>:avrdude-loop - -Du kannst den Loop mit STRG + C unterbrechen sobald der Vorgang abgeschlossen ist. Die korrekte Tastenkombination kann abweichen und hängt vom Betriebssystem ab. - - -### HalfKay - -Fü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: - - make <meine_Tastatur>:<meine_Tastaturbelegung>:teensy - -Wenn 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: - - make ergodox_ez:xyverz:teensy - -Nachdem die Kompilation abgeschlossen ist sollte die Ausgabe ungefähr so aussehen: - -``` -Linking: .build/ergodox_ez_xyverz.elf [OK] -Creating load file for flashing: .build/ergodox_ez_xyverz.hex [OK] -Checking file size of ergodox_ez_xyverz.hex [OK] - * File size is fine - 25584/32256 - Teensy Loader, Command Line, Version 2.1 -Read "./.build/ergodox_ez_xyverz.hex": 25584 bytes, 79.3% usage -Waiting for Teensy device... - (hint: press the reset button) - ``` - -An 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: - - ``` -Found HalfKay Bootloader -Read "./.build/ergodox_ez_xyverz.hex": 28532 bytes, 88.5% usage -Programming............................................................. -................................................... -Booting -``` - -### BootloadHID - -Fü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: - - make <meine_Tastatur>:<meine_Tastaturbelegung>:bootloaderHID - -Wenn deine Tastaturbelegung zum Beispiel den Namen "xyverz" hat und Du eine Tastaturbelegung für ein jj40 erzeugen möchtest, lautet der Befehl dafür: - - make jj40:xyverz:bootloaderHID - -Nachdem die Kompilation abgeschlossen ist sollte die Ausgabe ungefähr so aussehen: - -``` -Linking: .build/jj40_default.elf [OK] -Creating load file for flashing: .build/jj40_default.hex [OK] -Copying jj40_default.hex to qmk_firmware folder [OK] -Checking file size of jj40_default.hex [OK] - * The firmware size is fine - 21920/28672 (6752 bytes free) -``` - -Wenn 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. - -``` -Error opening HIDBoot device: The specified device was not found -Trying again in 5s. -``` - -An 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: - -``` -Page size = 128 (0x80) -Device size = 32768 (0x8000); 30720 bytes remaining -Uploading 22016 (0x5600) bytes starting at 0 (0x0) -0x05580 ... 0x05600 -``` - -### STM32 (ARM) - -Fü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: - - make <meine_Tastatur>:<meine_Tastaturbelegung>:dfu-util - -Wenn 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): - - make planck/rev6:xyverz:dfu-util - -Nachdem der Kompiliervorgang abgeschlossen ist sollte die Ausgabe ungefähr so aussehen: - -Fü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: - - make <meine_Tastatur>:<meine_Tastaturbelegung>:bootloaderHID - -Wenn deine Tastaturbelegung zum Beispiel den Namen "xyverz" hat und Du eine Tastaturbelegung für ein jj40 erzeugen möchtest, lautet der Befehl dafür: -``` -Linking: .build/planck_rev6_xyverz.elf [OK] -Creating binary load file for flashing: .build/planck_rev6_xyverz.bin [OK] -Creating load file for flashing: .build/planck_rev6_xyverz.hex [OK] - -Size after: - text data bss dec hex filename - 0 41820 0 41820 a35c .build/planck_rev6_xyverz.hex - -Copying planck_rev6_xyverz.bin to qmk_firmware folder [OK] -dfu-util 0.9 - -Copyright 2005-2009 Weston Schmidt, Harald Welte and OpenMoko Inc. -Copyright 2010-2016 Tormod Volden and Stefan Schmidt -This program is Free Software and has ABSOLUTELY NO WARRANTY -Please report bugs to http://sourceforge.net/p/dfu-util/tickets/ - -Invalid DFU suffix signature -A valid DFU suffix will be required in a future dfu-util release!!! -Opening DFU capable USB device... -ID 0483:df11 -Run-time device DFU version 011a -Claiming USB DFU Interface... -Setting Alternate Setting #0 ... -Determining device status: state = dfuERROR, status = 10 -dfuERROR, clearing status -Determining device status: state = dfuIDLE, status = 0 -dfuIDLE, continuing -DFU mode device DFU version 011a -Device returned transfer size 2048 -DfuSe interface name: "Internal Flash " -Downloading to address = 0x08000000, size = 41824 -Download [=========================] 100% 41824 bytes -Download done. -File downloaded successfully -Transitioning to dfuMANIFEST state -``` - -#### STM32 Befehle - -Für Tastaturen mit STM32 Controller sind die DFU Befehle wie folgt: - -* `:dfu-util` - The default command for flashing to STM32 devices. -* `:dfu-util` - Der Standard-Befehl für STM32 Geräte. -* `: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. - * z.B.: `make <meine_Tastatur>:<meine_Tastaturbelegung>:dfu-util TIME_DELAY=5` -* `:dfu-util-split-left` - Gleiche Funktionsweise wie `dfu-util`, jedoch wird zusätzlich das EEPROM Setting "linke Seite" für geteilte Tastaturen gesetzt. -* `:dfu-util-split-right` - Gleiche Funktionsweise wie `dfu-util`, jedoch wird zusätzlich das EEPROM Setting "rechte Seite" für geteilte Tastaturen gesetzt. - -## Probier's aus! - -Herzlichen Glückwunsch! Deine individuell angepasst Firmware wurde auf deine Tastatur übertragen! - - 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 188cf97e0a..0000000000 --- a/docs/de/newbs_getting_started.md +++ /dev/null @@ -1,101 +0,0 @@ -# Einleitung -Genau wie in einem Computer befindet sich auch in einer Tastatur ein Prozessor. - -Dieser Prozessor führt Software aus, die registriert wenn Tasten gedrückt bzw. wieder losgelassen werden und leitet die entsprechenden Signale an den Computer weiter. - -QMK ü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. - -QMK 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. - -# Los geht's! -Bevor 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. - -Wenn 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) - -## Software herunterladen - -### Text Editor - -Du 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. - -Ansonsten 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/). - -?> 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). - -### QMK Toolbox - -QMK 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. - -[Hier kannst Du die aktuelle Version herunterladen.](https://github.com/qmk/qmk_toolbox/releases/latest) - -* Für Windows: `qmk_toolbox.exe` (portable) oder `qmk_toolbox_install.exe` (installer) -* Für macOS: `QMK.Toolbox.app.zip` (portable) oder `QMK.Toolbox.pkg` (installer) - -## Die Entwicklungsumgebung aufsetzen - - -Wir 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. - -?> 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> -[Erforderliche Linux Grundlagen](https://www.guru99.com/must-know-linux-commands.html)<br> -[Noch ein paar Linux Befehle](https://www.tjhsst.edu/~dhyatt/superap/unixcmd.html) - -### Windows - -Du wirst MSYS2 (o.Ä.) und Git benötigen. - -* Befolge die Installationsanleitung auf der [MSYS2 Homepage](https://www.msys2.org) -* Schließe alle offenen MSYS2 Fenster und öffne ein neues MSYS2 MinGW 64-bit Terminal -* Installiere Git mit dem Kommando: `pacman -S git` - -### macOS - -Du wirst Homebrew benötigen. Folge dafür den Anweisungen auf der [Homebrew homepage](https://brew.sh). - -Nachdem Homebrew erfolgreich installiert ist, kannst Du mit _QMK aufsetzen_ fortfahren. - -### Linux - -Du 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: - -* Debian / Ubuntu / Devuan: `apt-get install git` -* Fedora / Red Hat / CentOS: `yum install git` -* Arch Linux: `pacman -S git` - -?> Docker ist ebenfalls eine Option für alle Plattformen. [Hier](de/getting_started_build_tools.md#docker) kannst Du dazu weitere Informationen finden. - -## QMK aufsetzen -Wenn 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: - -```shell -git clone --recurse-submodules https://github.com/qmk/qmk_firmware.git -cd qmk_firmware -``` -?> 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. - -QMK liefert ein Script mit, das helfen soll, Dir alles Weitere abzunehmen. Du kannst es mit dem folgenden Befehl aufrufen: - - util/qmk_install.sh - -## Die Build-Umgebung testen - -Nun 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: - - make <keyboard>:default - -Der Befehl um z.B. die Firmware für ein _Clueboard 66%_ zu erzeugen lautet: - - make clueboard/66/rev3:default - -Wenn es fertig ist, sollte der Output ungefähr so ähnlich wie das Folgende aussehen: - -``` -Linking: .build/clueboard_66_rev3_default.elf [OK] -Creating load file for flashing: .build/clueboard_66_rev3_default.hex [OK] -Copying clueboard_66_rev3_default.hex to qmk_firmware folder [OK] -Checking file size of clueboard_66_rev3_default.hex [OK] - * The firmware size is fine - 26356/28672 (2316 bytes free) -``` - -# Eine eigene Tastaturbelegung erstellen -Du 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 ac5adb0c12..0000000000 --- a/docs/de/newbs_learn_more_resources.md +++ /dev/null @@ -1,14 +0,0 @@ -# Lernmaterial - -Diese weiterführenden Ressourcen sind darauf ausgerichtet, Neulingen der QMK Commmunity mehr Informationen und ein besseres Verständnis zu einzelnen Themen zu bieten. - -Git Ressourcen: - -* [Gutes allgemeines Tutorial](https://www.codecademy.com/learn/learn-git) (auf Englisch) -* [Git spielerisch anhand von Beispielen lernen](https://learngitbranching.js.org/) (auf Englisch) -* [Mehr über den allgemeinen Umgang mit GitHub](getting_started_github.md) -* [Mehr über Git im Bezug zu QMK](contributing.md) - -Mehr über die Arbeit mit der Befehlszeile: - -* [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 4d4e7cfee6..0000000000 --- a/docs/de/newbs_testing_debugging.md +++ /dev/null @@ -1,102 +0,0 @@ -# Testen und Debuggen - -Nachdem 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. - -## Testen - -Die 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. - -Anmerkung: Diese Programme werden weder von QMK bereitgestellt oder gutgeheißen. - -* [Switch Hitter](https://elitekeyboards.com/switchhitter.php) (Nur für Windows) -* [Keyboard Viewer](https://www.imore.com/how-use-keyboard-viewer-your-mac) (Nur für Mac) -* [Keyboard Tester](https://www.keyboardtester.com) (Web basiert) -* [Keyboard Checker](https://keyboardchecker.com) (Web basiert) - -## Debuggen - -Deine 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. - -```c -void keyboard_post_init_user(void) { - // Customise these values to desired behaviour - debug_enable=true; - debug_matrix=true; - //debug_keyboard=true; - //debug_mouse=true; -} -``` - -### Debuggen mit der QMK Toolbox - -Für kompatible Plattformen kann die [QMK Toolbox](https://github.com/qmk/qmk_toolbox) benutzt werden um Debug-Nachrichten deiner Tastatur anzuzeigen. - -### Debuggen mit hid_listen - -Bevorzugst 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. - -<!-- FIXME: Describe the debugging messages here. --> - -## Eigene Debug-Nachrichten senden - -Manchmal 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: - -```c -#include "print.h" -``` - -Danach stehen dir verschiedene Druck-Funktionen zur Verfügung: - -* `print("string")`: Druckt einen simplen String -* `uprintf("%s string", var)`: Druckt einen formatierten String -* `dprint("string")` Druckt einen simplen String, aber nur wenn der Debug-Mode aktiviert ist -* `dprintf("%s string", var)`: Druckt einen formatierten String, aber nur wenn der Debug-Mode aktiviert ist - -## Debug Beispiele - -Anbei 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. - -### Which matrix position is this keypress? -### Welche Matrix Position hat dieser Tastenanschlag - -Beim 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. - -```c -bool process_record_user(uint16_t keycode, keyrecord_t *record) { - // Wenn 'console' aktiviert ist wird die Matrix-Position und der Status jedes Tastenanschlags ausgegeben -#ifdef CONSOLE_ENABLE - uprintf("KL: kc: %u, col: %u, row: %u, pressed: %u\n", keycode, record->event.key.col, record->event.key.row, record->event.pressed); -#endif - return true; -} -``` - -Beispiel Ausgabe: -```text -Waiting for device:....... -Listening: -KL: kc: 169, col: 0, row: 0, pressed: 1 -KL: kc: 169, col: 0, row: 0, pressed: 0 -KL: kc: 174, col: 1, row: 0, pressed: 1 -KL: kc: 174, col: 1, row: 0, pressed: 0 -KL: kc: 172, col: 2, row: 0, pressed: 1 -KL: kc: 172, col: 2, row: 0, pressed: 0 -``` - -### Wieviel Zeit wurde benötigt um einen Tastenanschlag zu detektieren? - -Wenn 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. - -```c -#define DEBUG_MATRIX_SCAN_RATE -``` - -Beispiel Ausgabe -```text - > matrix scan frequency: 315 - > matrix scan frequency: 313 - > matrix scan frequency: 316 - > matrix scan frequency: 316 - > matrix scan frequency: 316 - > matrix scan frequency: 316 -``` diff --git a/docs/es/README.md b/docs/es/README.md deleted file mode 100644 index 0d504fad05..0000000000 --- a/docs/es/README.md +++ /dev/null @@ -1,31 +0,0 @@ -# Firmware Quantum Mechanical Keyboard - -[](https://github.com/qmk/qmk_firmware/tags) -[](https://discord.gg/Uq7gcHh) -[](https://docs.qmk.fm) -[](https://github.com/qmk/qmk_firmware/pulse/monthly) -[](https://github.com/qmk/qmk_firmware/) - -## ¿Qué es el firmware QMK? - -QMK (*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. - -## Cómo conseguirlo - -Si 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. - -De 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`). - -## Cómo compilar - -Antes 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: - - make planck/rev4:default - -Este 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: - - make preonic:default - -## Cómo personalizar - -QMK 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 aa2a0ca5d9..0000000000 --- a/docs/es/_summary.md +++ /dev/null @@ -1,122 +0,0 @@ -* [Guía completa para novatos](es/newbs.md) - * [Empezando](es/newbs_getting_started.md) - * [Construyendo tu primer firmare](es/newbs_building_firmware.md) - * [Flasheando el firmware](es/newbs_flashing.md) - * [Testeando y depurando ](es/newbs_testing_debugging.md) - * [Mejores práticas](es/newbs_best_practices.md) - * [Recursos de aprendizaje](es/newbs_learn_more_resources.md) - -* [QMK Basics](es/README.md) - * [Introducción a QMK](es/getting_started_introduction.md) - * [QMK CLI](es/cli.md) - * [Configuración de QMK CLI](es/cli_configuration.md) - * [Contribuyendo a QMK](es/contributing.md) - * [Cómo usar GitHub](es/getting_started_github.md) - * [Obtener ayuda](es/getting_started_getting_help.md) - -* [Cambios incompatibles](es/breaking_changes.md) - * [30 Ago 2019](es/ChangeLog/20190830.md) - -* [Preguntas frecuentes](es/faq.md) - * [General](es/faq_general.md) - * [Construir/Compilar QMK](es/faq_build.md) - * [Depurando/Encontrando problemas en QMK](es/faq_debug.md) - * [Keymap](es/faq_keymap.md) - * [Instalación de drivers con Zadig](es/driver_installation_zadig.md) - -* Guías detalladas - * [Instalar herramientas construcción](es/getting_started_build_tools.md) - * [Guía Vagrant](es/getting_started_vagrant.md) - * [Instrucciones de Construcción/Compilado](es/getting_started_make_guide.md) - * [Flasheando Firmware](es/flashing.md) - * [Personalizando funcionalidad](es/custom_quantum_functions.md) - * [Visión general del Keymap](es/keymap.md) - -* [Hardware](es/hardware.md) - * [Procesadores AVR](es/hardware_avr.md) - * [Drivers](es/hardware_drivers.md) - -* Referencia - * [Pautas de teclados](es/hardware_keyboard_guidelines.md) - * [Opciones de configuración](es/config_options.md) - * [Keycodes](es/keycodes.md) - * [Convenciones de código - C](es/coding_conventions_c.md) - * [Convenciones de código - Python](es/coding_conventions_python.md) - * [Mejores prácticas de documentación](es/documentation_best_practices.md) - * [Plantillas de documentación](es/documentation_templates.md) - * [Glosario](es/reference_glossary.md) - * [Tests unitarios](es/unit_testing.md) - * [Funciones útiles](es/ref_functions.md) - * [Sporte configurador](es/reference_configurator_support.md) - * [Formato info.json](es/reference_info_json.md) - * [Desarrollo Python CLI](es/cli_development.md) - -* [Características](es/features.md) - * [Keycodes Básicos](es/keycodes_basic.md) - * [Teclas US ANSI Shifted](es/keycodes_us_ansi_shifted.md) - * [Keycodes Quantum](es/quantum_keycodes.md) - * [Keycodes Avanzados](es/feature_advanced_keycodes.md) - * [Audio](es/feature_audio.md) - * [Auto Shift](es/feature_auto_shift.md) - * [Retroiluminación](es/feature_backlight.md) - * [Bluetooth](es/feature_bluetooth.md) - * [Bootmagic](es/feature_bootmagic.md) - * [Combos](es/feature_combo.md) - * [Comando](es/feature_command.md) - * [API Debounce](es/feature_debounce_type.md) - * [Switch DIP](es/feature_dip_switch.md) - * [Macros Dinámicas](es/feature_dynamic_macros.md) - * [Encoders](es/feature_encoders.md) - * [Grave Escape](es/feature_grave_esc.md) - * [Feedback Háptico](es/feature_haptic_feedback.md) - * [Controlador LCD HD44780](es/feature_hd44780.md) - * [Key Lock](es/feature_key_lock.md) - * [Layouts](es/feature_layouts.md) - * [Tecla Leader](es/feature_leader_key.md) - * [Matriz LED](es/feature_led_matrix.md) - * [Macros](es/feature_macros.md) - * [Teclas del ratón](es/feature_mouse_keys.md) - * [Driver OLED](es/feature_oled_driver.md) - * [Teclas One Shot](es/one_shot_keys.md) - * [Dispositivo de apuntado](es/feature_pointing_device.md) - * [Ratón PS/2](es/feature_ps2_mouse.md) - * [Iluminación RGB](es/feature_rgblight.md) - * [Matriz RGB](es/feature_rgb_matrix.md) - * [Cadete espacial](es/feature_space_cadet.md) - * [Teclado dividido](es/feature_split_keyboard.md) - * [Stenografía](es/feature_stenography.md) - * [Swap Hands](es/feature_swap_hands.md) - * [Tap Dance](es/feature_tap_dance.md) - * [Terminal](es/feature_terminal.md) - * [Impresora Térmica](es/feature_thermal_printer.md) - * [Unicode](es/feature_unicode.md) - * [Userspace](es/feature_userspace.md) - * [Velocikey](es/feature_velocikey.md) - -* Para Makers y Modders - * [Guía de cableado a mano](es/hand_wire.md) - * [Guía de flasheado de ISP](es/isp_flashing_guide.md) - * [Guía de depuración de ARM](es/arm_debugging.md) - * [Driver I2C](es/i2c_driver.md) - * [Driver SPI](es/spi_driver.md) - * [Controles GPIO](es/internals_gpio_control.md) - * [Conversión Proton C](es/proton_c_conversion.md) - -* Para entender en profundidad - * [Cómo funcionan los teclados](es/how_keyboards_work.md) - * [Entendiendo QMK](es/understanding_qmk.md) - -* Otros temas - * [Usando Eclipse con QMK](es/other_eclipse.md) - * [Usando VSCode con QMK](es/other_vscode.md) - * [Soporte](es/getting_started_getting_help.md) - * [Cómo añadir traducciones](es/translating.md) - -* QMK Internals (En progreso) - * [Defines](es/internals_defines.md) - * [Input Callback Reg](es/internals_input_callback_reg.md) - * [Dispositivo Midi](es/internals_midi_device.md) - * [Proceso de configuración de un dispositivo Midi](es/internals_midi_device_setup_process.md) - * [Utilidad Midi](es/internals_midi_util.md) - * [Funciones Send](es/internals_send_functions.md) - * [Herramientas Sysex](es/internals_sysex_tools.md) diff --git a/docs/es/hardware.md b/docs/es/hardware.md deleted file mode 100644 index 085c7e6745..0000000000 --- a/docs/es/hardware.md +++ /dev/null @@ -1,8 +0,0 @@ -# Hardware - -QMK 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. - -* [Pautas de teclados](hardware_keyboard_guidelines.md) -* [Procesadores AVR](hardware_avr.md) -* Procesadores ARM (TBD) -* [Drivers](hardware_drivers.md) diff --git a/docs/es/hardware_avr.md b/docs/es/hardware_avr.md deleted file mode 100644 index ac6a715658..0000000000 --- a/docs/es/hardware_avr.md +++ /dev/null @@ -1,182 +0,0 @@ -# Teclados con Procesadores AVR - -Esta 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. - -Si 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. - -## Añadir tu Teclado AVR a QMK - -QMK 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`: - -``` -$ qmk new-keyboard -Ψ Generating a new QMK keyboard directory - -Keyboard Name: mycoolkeeb -Keyboard Type: - 1. avr - 2. ps2avrgb -Please enter your choice: [1] -Your Name: [John Smith] -Ψ Copying base template files... -Ψ Copying avr template files... -Ψ Renaming keyboard.[ch] to mycoolkeeb.[ch]... -Ψ Replacing %YEAR% with 2021... -Ψ Replacing %KEYBOARD% with mycoolkeeb... -Ψ Replacing %YOUR_NAME% with John Smith... - -Ψ Created a new keyboard called mycoolkeeb. -Ψ To start working on things, `cd` into keyboards/mycoolkeeb, -Ψ or open the directory in your preferred text editor. -``` - -Esto 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. - -## `readme.md` - -Aquí 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. - -## `<keyboard>.c` - -Aquí 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). - -## `<keyboard>.h` - -Este 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í: - -```c -#define LAYOUT( \ - k00, k01, k02, \ - k10, k11 \ -) { \ - { k00, k01, k02 }, \ - { k10, KC_NO, k11 }, \ -} -``` - -La 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. - -Cada una de las variables `k__` tiene que ser única, y normalmente sigue el formato `k<row><col>`. - -La 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. - -## `config.h` - -El 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). - -### Configuración de hardware - - -En 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. - -Cambia las líneas de `MANUFACTURER` y `PRODUCT` para reflejar con precisión tu teclado. - -```c -#define VENDOR_ID 0xFEED -#define PRODUCT_ID 0x6060 -#define DEVICE_VER 0x0001 -#define MANUFACTURER Tú -#define PRODUCT mi_teclado_fantastico -``` - -?> 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. - -### Configuración de la matriz del teclado - -La 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. - -```c -#define MATRIX_ROWS 2 -#define MATRIX_COLS 3 -``` - -Una 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: - -```c -#define MATRIX_ROW_PINS { D0, D5 } -#define MATRIX_COL_PINS { F1, F0, B0 } -#define UNUSED_PINS -``` - -El 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. - -Finalmente, puedes especificar la dirección en la que apuntan tus diodos. Esto puede ser `COL2ROW` o `ROW2COL`. - -```c -#define DIODE_DIRECTION COL2ROW -``` - -#### Matriz de patas directas -Para 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`. - -```c -// #define MATRIX_ROW_PINS { D0, D5 } -// #define MATRIX_COL_PINS { F1, F0, B0 } -#define DIRECT_PINS { \ - { F1, E6, B0, B2, B3 }, \ - { F5, F0, B1, B7, D2 }, \ - { F6, F7, C7, D5, D3 }, \ - { B5, C6, B6, NO_PIN, NO_PIN } \ -} -#define UNUSED_PINS - -/* COL2ROW, ROW2COL */ -//#define DIODE_DIRECTION -``` - -### Configuración de retroiluminación - -QMK 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). - -```c -#define BACKLIGHT_PIN B7 -#define BACKLIGHT_LEVELS 3 -#define BACKLIGHT_BREATHING -#define BREATHING_PERIOD 6 -``` - -### Otras opciones de configuración - -Hay 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. - -## `rules.mk` - -Usa 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. - -### Opciones MCU - -Estas 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. - -```make -MCU = atmega32u4 -F_CPU = 16000000 -ARCH = AVR8 -F_USB = $(F_CPU) -OPT_DEFS += -DINTERRUPT_CONTROL_ENDPOINT -``` - -### Gestores de arranque - -El 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. - -#### Ejemplo de gestor de arranque - -```make -BOOTLOADER = halfkay -``` - -#### Ejemplo de cargador DFU Atmel - -```make -BOOTLOADER = atmel-dfu -``` - -#### Ejemplo de gestor de arranque Pro Micro - -```make -BOOTLOADER = caterina -``` - -### Opciones de construcción - -Hay 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 788de2c5ef..0000000000 --- a/docs/es/hardware_drivers.md +++ /dev/null @@ -1,31 +0,0 @@ -# Controladores de hardware QMK - -QMK 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. - -<!-- FIXME: Esto debe hablar de cómo se integran los controladores en QMK y cómo puedes añadir su propio controlador. - -# Descripción del sistema de controladores - ---> - -# Controladores disponibles - -## ProMicro (Solo AVR) - -Soporte 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. - -## Controlador OLED SSD1306 - -Soporte 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). - -## WS2812 (Solo AVR) - -Soporte para LEDs WS2811/WS2812{a,b,c}. Para obtener más información consulta la página de [Luz RGB](feature_rgblight.md). - -## IS31FL3731 - -Soporte 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). - -## IS31FL3733 - -Soporte 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 298a3b7ce7..0000000000 --- a/docs/es/hardware_keyboard_guidelines.md +++ /dev/null @@ -1,147 +0,0 @@ -# Pautas del teclado QMK - -Desde 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. - - -## Nombrar tu Teclado/Proyecto - -Todos 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. - -Los 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. - -Ejemplos Válidos: - -* `412_64` -* `chimera_ortho` -* `clueboard/66/rev3` -* `planck` -* `v60_type_r` - -## Subcarpetas - -QMK 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: - - qmk_firmware/keyboards/top_folder/sub_1/sub_2/sub_3/sub_4 - -Si 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`. - -Ejemplo: - -Clueboard utiliza subcarpetas para ambos propósitos: organización y revisiones de teclado. - -* [`qmk_firmware`](https://github.com/qmk/qmk_firmware/tree/master) - * [`keyboards`](https://github.com/qmk/qmk_firmware/tree/master/keyboards) - * [`clueboard`](https://github.com/qmk/qmk_firmware/tree/master/keyboards/clueboard) ← This is the organization folder, there's no `rules.mk` file - * [`60`](https://github.com/qmk/qmk_firmware/tree/master/keyboards/clueboard/60) ← This is a compilable keyboard, it has a `rules.mk` file - * [`66`](https://github.com/qmk/qmk_firmware/tree/master/keyboards/clueboard/66) ← This is also compilable- it uses `DEFAULT_FOLDER` to specify `rev3` as the default revision - * [`rev1`](https://github.com/qmk/qmk_firmware/tree/master/keyboards/clueboard/66/rev1) ← compilable: `make clueboard/66/rev1` - * [`rev2`](https://github.com/qmk/qmk_firmware/tree/master/keyboards/clueboard/66/rev2) ← compilable: `make clueboard/66/rev2` - * [`rev3`](https://github.com/qmk/qmk_firmware/tree/master/keyboards/clueboard/66/rev3) ← compilable: `make clueboard/66/rev3` or `make clueboard/66` - -## Estructura de carpetas de teclado - -Su 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: - -* `readme.md` -* `info.json` -* `config.h` -* `rules.mk` -* `<keyboard_name>.c` -* `<keyboard_name>.h` - -### `readme.md` - -Todos 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). - -### `info.json` - -Este 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). - -### `config.h` - -Todos 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. - -### `rules.mk` - -La 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. - -### `<keyboard_name.c>` - -Aquí 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. - -Las funciones siguientes se definen típicamente en este archivo: - -* `void matrix_init_kb(void)` -* `void matrix_scan_kb(void)` -* `bool process_record_kb(uint16_t keycode, keyrecord_t *record)` -* `void led_set_kb(uint8_t usb_led)` - -### `<keyboard_name.h>` - -Este 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. - -Si solo tienes un diseño debes llamar a esta macro `LAYOUT`. - -Al 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. - -Los nombres de las macros de diseño son completamente minúsculas, excepto por la palabra `LAYOUT` en el frente. - -Por ejemplo, si tienes un PCB de 60% que soporta ANSI e ISO podría definir los siguientes diseños y keymaps: - -| Nombre de diseño | Nombre de keymap | Descripción | -|-------------|-------------|-------------| -| LAYOUT_all | default | Un diseño que soporta tanto ISO como ANSI | -| LAYOUT_ansi | default_ansi | Un diseño ANSI | -| LAYOUT_iso | default_iso | Un diseño ISO | - -## Archivos de Imagen/Hardware - -En 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. - -Para 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. - -## Predeterminados de teclado - -Dada 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. - -### Bootmagic y Command - -[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. - -De 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. - -Si 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. - -## Programación de teclado personalizado - -Como 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`. - -## Proyectos Sin Producción/Conectados A Mano - -Estamos 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! - -## Advertencias como errores - -Al 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). - -## Derechos de autor - -Si 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: - - Copyright 2017 Tu nombre <tu@email.com> - -Si 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í: - - Copyright 2017 Su nombre <original_author@ejemplo.com> Tu nombre <tu@ejemplo.com> - -El 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í: - - Copyright 2015-2017 Tu nombre <tu@ejemplo.com> - -## Licencia - -El 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. - -## Detalles técnicos - -Si 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 7e08b679c3..0000000000 --- a/docs/es/newbs.md +++ /dev/null @@ -1,23 +0,0 @@ -# La guía completa de QMK para novatos - -QMK 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. - -¿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. - -## Visión general - -Hay 7 secciones principales en esta guía: - -* [Empezando](newbs_getting_started.md) -* [Construyendo tu primer firmware](newbs_building_firmware.md) -* [Construyendo tu primer firmware usando la GUI](newbs_building_firmware_configurator.md) -* [Flasheando el firmware](newbs_flashing.md) -* [Testeando y depurando](newbs_testing_debugging.md) -* [Mejores práticas](newbs_best_practices.md) -* [Recursos de aprendizaje](newbs_learn_more_resources.md) - -Esta 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). - -## Recursos adicionales - -* [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 2f72eff788..0000000000 --- a/docs/es/newbs_best_practices.md +++ /dev/null @@ -1,159 +0,0 @@ -# Mejores prácticas - -## O, "Cómo aprendí a dejar de preocuparme y amarle a Git." - -Este 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. - -En este documento suponemos un par de cosas: - -1. Tienes una cuenta de GitHub, y has hecho un [fork del repo qmk_firmware](getting_started_github.md) en tu cuenta. -2. Has [configurado tu entorno de desarrollo](newbs_getting_started.md?id=environment-setup). - - -## La rama master de tu fork: Actualizar a menudo, nunca commit - -Se 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. - -Para evitar los conflictos de merge — cuando dos o más usuarios han editado la misma parte de un archivo al mismo tiempo — mantén tu rama `master` actualizada, y empieza desarrollo nuevo creando una nueva rama. - -### Actualizando tu rama master - -Para 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: -``` -git remote add upstream https://github.com/qmk/qmk_firmware.git -``` - -Para verificar que el repo ha sido agregado, ejecuta `git remote -v`, y lo siguiente debe aparecer: - -``` -$ git remote -v -origin https://github.com/<your_username>/qmk_firmware.git (fetch) -origin https://github.com/<your_username>/qmk_firmware.git (push) -upstream https://github.com/qmk/qmk_firmware.git (fetch) -upstream https://github.com/qmk/qmk_firmware.git (push) -``` - -Ya que has hecho esto, puedes buscar actualizaciones del repo ejecutando `git fetch upstream`. Esto busca las ramas y etiquetas — juntos conocidos como "refs" — del repo QMK, que ahora tiene el apodo `upstream`. Ahora podemos comparar los archivos en nuestro fork `origin` con los de QMK. - -Para actualizar la rama master de tu fork, ejecuta lo siguiente, pulsando Intro después de cada línea: - -``` -git checkout master -git fetch upstream -git pull upstream master -git push origin master -``` - -Esto 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. - -### Hacer cambios - -Para hacer cambios, crea una nueva rama ejecutando: - -``` -git checkout -b dev_branch -git push --set-upstream origin dev_branch -``` - -Esto 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. - -!> Con `git push`, puedes usar `-u` en vez de `--set-upstream` — `-u` es un alias de `--set-upstream`. - -Puedes nombrar tu rama casi cualquier cosa, pero se recomienda ponerle algo con relación a los cambios que vas a hacer. - -Por 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: - -``` -git checkout -b dev_branch master -``` - -Ahora 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: - -``` -git add path/to/updated_file -git commit -m "My commit message." -``` -`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. - -!> 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. - -### Publicar tus cambios - -El ú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. - - -## Resolver los conflictos del merge - -A 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. - -### Rebase tus cambios - -Un *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. - -Para empezar, ejecuta lo siguiente: - -``` -git fetch upstream -git rev-list --left-right --count HEAD...upstream/master -``` - -El 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: - -``` -$ git rev-list --left-right --count HEAD...upstream/master -7 35 -``` - -El 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. - -Ahora que sabemos el estado actual de la rama actual y el del repo upstream, podemos empezar una operación rebase: - -``` -git rebase upstream/master -``` -Esto le dice a Git que deshaga los commits en la rama actual, y después los re-aplica en la rama master de QMK. - -``` -$ git rebase upstream/master -First, rewinding head to replay your work on top of it... -Applying: Commit #1 -Using index info to reconstruct a base tree... -M conflicting_file_1.txt -Falling back to patching base and 3-way merge... -Auto-merging conflicting_file_1.txt -CONFLICT (content): Merge conflict in conflicting_file_1.txt -error: Failed to merge in the changes. -hint: Use 'git am --show-current-patch' to see the failed patch -Patch failed at 0001 Commit #1 - -Resolve all conflicts manually, mark them as resolved with -"git add/rm <conflicted_files>", then run "git rebase --continue". -You can instead skip this commit: run "git rebase --skip". -To abort and get back to the state before "git rebase", run "git rebase --abort". -``` - -Esto 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í: - -``` -<<<<<<< HEAD -<p>For help with any issues, email us at support@webhost.us.</p> -======= -<p>Need help? Email support@webhost.us.</p> ->>>>>>> Commit #1 -``` -La 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. - -Ya 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. - -``` -<p>Need help? Email support@webhost.us.</p> -``` - -Ahora ejecuta: - -``` -git add conflicting_file_1.txt -git rebase --continue -``` - -Git 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 ff9873c785..0000000000 --- a/docs/es/newbs_building_firmware.md +++ /dev/null @@ -1,81 +0,0 @@ -# Construyendo tu primer firmware - -Ahora 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. - -Si 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. - -## Navega a tu carpeta de keymaps - -Comienza navegando a la carpeta `keymaps` correspondiente a tu teclado. - -?> Si estás en macOS o Windows hay comandos que puedes utilizar fácilmente para abrir la carpeta keymaps. - -?> macOS: - - abre keyboards/<keyboard_folder>/keymaps - -?> Windows: - - inicia .\\keyboards\\<keyboard_folder>\\keymaps - -## Crea una copia del keymap `default` - -Una 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. - -Para automatizar el proceso, también tienes la opción de ejecutar el script `new_keymap.sh`. - -Navega a la carpeta `qmk_firmware/util` e introduce lo siguiente: - -``` -./new_keymap.sh <keyboard path> <username> -``` - -Por ejemplo, para un usuario llamado John, intentando hacer un keymap nuevo para el 1up60hse, tendría que teclear - -``` -./new_keymap.sh 1upkeyboards/1up60hse john -``` - -## Abre `keymap.c` con tu editor de texto favorito - -Abre 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: - - const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { - -Esta 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. - -!> 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. - -## Personaliza el Layout a tu gusto - -Có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í: - -* [Keycodes](keycodes.md) -* [Características](features.md) -* [Preguntas frecuentes](faq.md) - -?> 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. - -## Construye tu firmware - -Cuando 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: - - make <my_keyboard>:<my_keymap> - -Por ejemplo, si tu keymap se llama "xyverz" y estás construyendo un keymap para un planck rev5, utilizarás el siguiente comando: - - make planck/rev5:xyverz - -Mientras 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: - -``` -Linking: .build/planck_rev5_xyverz.elf [OK] -Creating load file for flashing: .build/planck_rev5_xyverz.hex [OK] -Copying planck_rev5_xyverz.hex to qmk_firmware folder [OK] -Checking file size of planck_rev5_xyverz.hex [OK] - * File size is fine - 18392/28672 -``` - -## Flashea tu firmware - -Continua 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 60d67f5fa4..0000000000 --- a/docs/es/newbs_building_firmware_configurator.md +++ /dev/null @@ -1,105 +0,0 @@ -# Configurador QMK - -El [Configurador QMK](https://config.qmk.fm) es un entorno gráfico online que genera ficheros hexadecimales de Firmware QMK. - -?> **Por favor sigue estos pasos en orden.** - -Ve el [Video tutorial](https://www.youtube.com/watch?v=-imgglzDMdY) - -El Configurador QMK functiona mejor con Chrome/Firefox. - - -!> **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. ** - -## Seleccionando tu teclado - -Haz click en el desplegable y selecciona el teclado para el que quieres crear el keymap. - -?> Si tu teclado tiene varias versiones, asegúrate de que seleccionas la correcta.** - -Lo diré otra vez porque es importante - -!> **ASEGÚRATE DE QUE SELECCIONAS LA VERSIÓN CORRECTA!** - -Si 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. - -## Eligiendo el layout de tu teclado - -Elige 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. - -## Nombre del keymap - -Llama a este keymap como quieras. - -?> 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. - -## Creando Tu keymap - -La adición de keycodes se puede hacer de 3 maneras. -1. Arrastrando y soltando -2. Clickando en un hueco vacío en el layout y haciendo click en el keycode que deseas -3. Clickando en un hueco vacío en el layout, presionando la tecla física en tu teclado. - -Mueve 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 - -[Referencia básica de keycodes](https://docs.qmk.fm/#/keycodes_basic) -[Referencia avanzada de keycodes](https://docs.qmk.fm/#/feature_advanced_keycodes) - -En 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. - -### Ejemplo: - -3 huecos para barra espaciadora: Rellena TODOS con barra espaciadora - -2 huecos para retroceso: Rellena AMBOS con retroceso - -2 huecos para el shift derecho: Rellena AMBOS con shift derecho - -1 hueco para el shift izquierdo y 1 hueco para soporte iso: Rellena ambos con el shift izquierdo - -5 huecos , pero sólo 4 teclas: Intuye y comprueba o pregunta a alguien que lo haya hecho anteriormente. - -## Guardando tu keymap para ediciones futuras - -Cuando 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. - -Entonces podrás cargar este fichero .json en el futuro pulsando el botón `Importar Keymap`. - -!> **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**. - -## Generando tu fichero de firmware - -Pulsa el botón verde `Compilar`. - -Cuando la compilación haya acabado, podrás presionar el botón verde `Descargar Firmware`. - -## Flasheando tu teclado - -Por favor, dirígete a la sección de [Flashear firmware](newbs_flashing.md) - -## Problemas comunes - -#### Mi fichero .json no funciona - -Si 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) - -Si no....cómo no viste el mensaje en negrita que puse arriba diciendo que no hay que utilizar otros ficheros .json? - -#### Hay espacios extra en mi layout ¿Qué hago? - -Si 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 - -#### Para qué sirve el keycode....... - -Por favor, mira - -[Referencia básica de keycodes](https://docs.qmk.fm/#/keycodes_basic) -[Referencia avanzada de keycodes](https://docs.qmk.fm/#/feature_advanced_keycodes) - -#### No compila - -Por favor, revisa las otras capas de tu keymap para asegurarte de que no hay teclas aleatorias presentes. - -## Problemas y bugs - -Siempre 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 066715c483..0000000000 --- a/docs/es/newbs_flashing.md +++ /dev/null @@ -1,351 +0,0 @@ -# Flasheando tu teclado - -Ahora que has construido tu fichero de firmware personalizado querrás flashear tu teclado. - -## Flasheando tu teclado con QMK Toolbox - -La manera más simple de flashear tu teclado sería con [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases). - -De 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). - -### Cargar el fichero en QMK Toolbox - -Empieza 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`. - -?> 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. - -?> Windows: - - start . - -?> macOS: - - open . - -El fichero de firmware sempre sigue el siguiente formato de nombre: - - <nombre_teclado>_<nombre_keymap>.{bin,hex} - -Por ejemplo, un `plank/rev5` con un keymap `default` tendrá este nombre de fichero: - - planck_rev5_default.hex - -Una 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. - -### Pon tu teclado en modo DFU (Bootloader) - -Para 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. - -Diferentes 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: - -* Manten pulsadas ambas teclas shift y pulsa `Pause` -* Manten pulsadas ambas teclas shift y pulsa `B` -* 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 -* Pulsa el botón físico `RESET` situado en el fondo de la PCB -* Localiza los pines en la PCB etiquetados on `BOOT0` o `RESET`, puentea estos dos juntos cuando enchufes la PCB - -Si has tenido éxito verás un mensaje similar a este en QMK Toolbox: - -``` -*** Clueboard - Clueboard 66% HotSwap disconnected -- 0xC1ED:0x2390 -*** DFU device connected -``` - -### Flashea tu teclado - -Haz click en el botón `Flash` de QMK Toolbox. Verás una información de salida similar a esta: - -``` -*** Clueboard - Clueboard 66% HotSwap disconnected -- 0xC1ED:0x2390 -*** DFU device connected -*** Attempting to flash, please don't remove device ->>> dfu-programmer atmega32u4 erase --force - Erasing flash... Success - Checking memory from 0x0 to 0x6FFF... Empty. ->>> dfu-programmer atmega32u4 flash /Users/skully/qmk_firmware/clueboard_66_hotswap_gen1_skully.hex - Checking memory from 0x0 to 0x55FF... Empty. - 0% 100% Programming 0x5600 bytes... - [>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>] Success - 0% 100% Reading 0x7000 bytes... - [>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>] Success - Validating... Success - 0x5600 bytes written into 0x7000 bytes memory (76.79%). ->>> dfu-programmer atmega32u4 reset - -*** DFU device disconnected -*** Clueboard - Clueboard 66% HotSwap connected -- 0xC1ED:0x2390 -``` - -## Flashea tu teclado desde la línea de comandos - -Lo 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. - -Puedes encontrar más información sobre bootloaders en la página [Instrucciones de flasheado e información de Bootloader](flashing.md). - -Si 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. - -### DFU - -Para 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: - - make <my_keyboard>:<my_keymap>:dfu - -Por ejemplo, si tu keymap se llama "xyverz" y estás construyendo un keymap para un planck rev5, utilizarás este comando: - - make planck/rev5:xyverz:dfu - -Una vez que finalice de compilar, deberá aparecer lo siguiente: - -``` -Linking: .build/planck_rev5_xyverz.elf [OK] -Creating load file for flashing: .build/planck_rev5_xyverz.hex [OK] -Copying planck_rev5_xyverz.hex to qmk_firmware folder [OK] -Checking file size of planck_rev5_xyverz.hex - * File size is fine - 18574/28672 - ``` - -Despué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: - - dfu-programmer: no device present. - Error: Bootloader not found. Trying again in 5s. - -Una vez haya hecho esto, tendrás que reiniciar el controlador. Debería mostrar una información de salida similar a esta: - -``` -*** Attempting to flash, please don't remove device ->>> dfu-programmer atmega32u4 erase --force - Erasing flash... Success - Checking memory from 0x0 to 0x6FFF... Empty. ->>> dfu-programmer atmega32u4 flash /Users/skully/qmk_firmware/clueboard_66_hotswap_gen1_skully.hex - Checking memory from 0x0 to 0x55FF... Empty. - 0% 100% Programming 0x5600 bytes... - [>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>] Success - 0% 100% Reading 0x7000 bytes... - [>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>] Success - Validating... Success - 0x5600 bytes written into 0x7000 bytes memory (76.79%). ->>> dfu-programmer atmega32u4 reset -``` - -?> 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). - -#### Comandos DFU - -Hay un número de comandos DFU que puedes usar para flashear firmware a un dispositivo DFU: - -* `: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. -* `:dfu-ee` - Esta flashea un fichero `eep` en vez del hex normal. Esto no es lo común. -* `: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._ -* `: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._ - - -### Caterina - -Para 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: - - make <my_keyboard>:<my_keymap>:avrdude - -Por ejemplo, si tu keymap se llama "xyverz" y estás construyendo un keymap para un Lets Split rev2, usarás este comando: - - make lets_split/rev2:xyverz:avrdude - -Una vez que finalice de compilar, deberá aparecer lo siguiente: - -``` -Linking: .build/lets_split_rev2_xyverz.elf [OK] -Creating load file for flashing: .build/lets_split_rev2_xyverz.hex [OK] -Checking file size of lets_split_rev2_xyverz.hex [OK] - * File size is fine - 27938/28672 -Detecting USB port, reset your controller now.............. -``` - -En 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: - -``` -Detected controller on USB port at /dev/ttyS15 - -Connecting to programmer: . -Found programmer: Id = "CATERIN"; type = S - Software Version = 1.0; No Hardware Version given. -Programmer supports auto addr increment. -Programmer supports buffered memory access with buffersize=128 bytes. - -Programmer supports the following devices: - Device code: 0x44 - -avrdude.exe: AVR device initialized and ready to accept instructions - -Reading | ################################################## | 100% 0.00s - -avrdude.exe: Device signature = 0x1e9587 (probably m32u4) -avrdude.exe: NOTE: "flash" memory has been specified, an erase cycle will be performed - To disable this feature, specify the -D option. -avrdude.exe: erasing chip -avrdude.exe: reading input file "./.build/lets_split_rev2_xyverz.hex" -avrdude.exe: input file ./.build/lets_split_rev2_xyverz.hex auto detected as Intel Hex -avrdude.exe: writing flash (27938 bytes): - -Writing | ################################################## | 100% 2.40s - -avrdude.exe: 27938 bytes of flash written -avrdude.exe: verifying flash memory against ./.build/lets_split_rev2_xyverz.hex: -avrdude.exe: load data flash data from input file ./.build/lets_split_rev2_xyverz.hex: -avrdude.exe: input file ./.build/lets_split_rev2_xyverz.hex auto detected as Intel Hex -avrdude.exe: input file ./.build/lets_split_rev2_xyverz.hex contains 27938 bytes -avrdude.exe: reading on-chip flash data: - -Reading | ################################################## | 100% 0.43s - -avrdude.exe: verifying ... -avrdude.exe: 27938 bytes of flash verified - -avrdude.exe: safemode: Fuses OK (E:CB, H:D8, L:FF) - -avrdude.exe done. Thank you. -``` -Si tienes problemas con esto, puede ser necesario que hagas esto: - - sudo make <my_keyboard>:<my_keymap>:avrdude - - -Adicionalmente, si quisieras flashear múltiples placas, usa el siguiente comando: - - make <keyboard>:<keymap>:avrdude-loop - -Cuando 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. - - -### HalfKay - -Para 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: - - make <my_keyboard>:<my_keymap>:teensy - -Por ejemplo, si tu keymap se llama "xyverz" y estás construyendo un keymap para un Ergodox o un Ergodox EZ, usarás este comando: - - make ergodox_ez:xyverz:teensy - -Una vez que el firmware acabe de compilar, deberá mostrar una información de salida como esta: - -``` -Linking: .build/ergodox_ez_xyverz.elf [OK] -Creating load file for flashing: .build/ergodox_ez_xyverz.hex [OK] -Checking file size of ergodox_ez_xyverz.hex [OK] - * File size is fine - 25584/32256 - Teensy Loader, Command Line, Version 2.1 -Read "./.build/ergodox_ez_xyverz.hex": 25584 bytes, 79.3% usage -Waiting for Teensy device... - (hint: press the reset button) - ``` - -En este punto, reinicia tu placa. Una vez que lo hayas hecho, deberás ver una información de salida como esta: - - ``` - Found HalfKay Bootloader -Read "./.build/ergodox_ez_xyverz.hex": 28532 bytes, 88.5% usage -Programming............................................................................................................................................................................ -................................................... -Booting -``` - -### BootloadHID - -Para 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: - - make <my_keyboard>:<my_keymap>:bootloaderHID - -Por ejemplo, si tu keymap se llama "xyverz" y estás construyendo un keymap para un jj40, usarás esté comando: - - make jj40:xyverz:bootloaderHID - -Una vez que el firmware acaba de compilar, mostrará una información de salida como esta: - -``` -Linking: .build/jj40_default.elf [OK] -Creating load file for flashing: .build/jj40_default.hex [OK] -Copying jj40_default.hex to qmk_firmware folder [OK] -Checking file size of jj40_default.hex [OK] - * The firmware size is fine - 21920/28672 (6752 bytes free) -``` - -Despué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. - -``` -Error opening HIDBoot device: The specified device was not found -Trying again in 5s. -``` - -Una vez que lo haga, querrás reinicar el controlador. Debería entonces mostrar una información de salida similar a esta: - -``` -Page size = 128 (0x80) -Device size = 32768 (0x8000); 30720 bytes remaining -Uploading 22016 (0x5600) bytes starting at 0 (0x0) -0x05580 ... 0x05600 -``` - -### STM32 (ARM) - -Para 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: - - make <my_keyboard>:<my_keymap>:dfu-util - -Por 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): - - make planck/rev6:xyverz:dfu-util - -Una vez que el firmware acaba de compilar, mostrará una información de salida similar a esta: - -``` -Linking: .build/planck_rev6_xyverz.elf [OK] -Creating binary load file for flashing: .build/planck_rev6_xyverz.bin [OK] -Creating load file for flashing: .build/planck_rev6_xyverz.hex [OK] - -Size after: - text data bss dec hex filename - 0 41820 0 41820 a35c .build/planck_rev6_xyverz.hex - -Copying planck_rev6_xyverz.bin to qmk_firmware folder [OK] -dfu-util 0.9 - -Copyright 2005-2009 Weston Schmidt, Harald Welte and OpenMoko Inc. -Copyright 2010-2016 Tormod Volden and Stefan Schmidt -This program is Free Software and has ABSOLUTELY NO WARRANTY -Please report bugs to http://sourceforge.net/p/dfu-util/tickets/ - -Invalid DFU suffix signature -A valid DFU suffix will be required in a future dfu-util release!!! -Opening DFU capable USB device... -ID 0483:df11 -Run-time device DFU version 011a -Claiming USB DFU Interface... -Setting Alternate Setting #0 ... -Determining device status: state = dfuERROR, status = 10 -dfuERROR, clearing status -Determining device status: state = dfuIDLE, status = 0 -dfuIDLE, continuing -DFU mode device DFU version 011a -Device returned transfer size 2048 -DfuSe interface name: "Internal Flash " -Downloading to address = 0x08000000, size = 41824 -Download [=========================] 100% 41824 bytes -Download done. -File downloaded successfully -Transitioning to dfuMANIFEST state -``` - -#### STM32 Commands - -Hay un número de comandos DFU que puedes usar para flashear firmware a un dispositivo DFU: - -* `:dfu-util` - El comando por defecto para flashing en dispositivos STM32. -* `: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. - * Eg: `make <keyboard>:<keymap>:dfu-util TIME_DELAY=5` -* `: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. -* `: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. - -## ¡Pruébalo! - -¡Felicidades! ¡Tu firmware personalizado ha sido programado en tu teclado! - -Prué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 046fdee27e..0000000000 --- a/docs/es/newbs_getting_started.md +++ /dev/null @@ -1,103 +0,0 @@ -# Introducción - -El 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. - -QMK 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. - -# Comenzando - -Antes 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. - -Si 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). - - -## Descarga el software - -### Editor de texto - -Necesitará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_. - -Tambié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. - -?> ¿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. - -### QMK Toolbox - -QMK 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. - -[Download the latest release here.](https://github.com/qmk/qmk_toolbox/releases/latest) - -* For Windows: `qmk_toolbox.exe` (portable) or `qmk_toolbox_install.exe` (installer) -* For macOS: `QMK.Toolbox.app.zip` (portable) or `QMK.Toolbox.pkg` (installer) - -## Configura tu entorno - -Hemos 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 -instale el resto. - -?> 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> -[Comandos de Linux que debería saber](https://www.guru99.com/must-know-linux-commands.html)<br> -[Algunos comandos básicos de Unix](https://www.tjhsst.edu/~dhyatt/superap/unixcmd.html) - -### Windows - -Necesitarás instalar MSYS2 y Git. - -* Sigue las instrucciones de instalación en la [página de MSYS2](https://www.msys2.org). -* Cierra las terminales abiertas de MSYS2 y abre una nueva termial de MSYS2 MinGW 64-bit. -* Instala Git ejecutando este comando: `pacman -S git`. - -### macOS - -Necesitarás instalar Homebrew. Sigue las instrucciones que encontrarás en la [página de Homebrew](https://brew.sh). - -Despueś de que se haya inastalado Homebrew, continúa con _Set Up QMK_. En ese paso ejecutará un script que instalará el resto de paquetes. - -### Linux - -Necesitarás instalar Git. Es bastante probable que ya lo tengas, pero si no, uno de los siguientes comandos debería instalarlo: - -* Debian / Ubuntu / Devuan: `apt-get install git` -* Fedora / Red Hat / CentOS: `yum install git` -* Arch: `pacman -S git` - -?> Docker es también una opción en todas las plataformas. [Haz click aquí si quieres detalles.](getting_started_build_tools.md#docker) - -## Configura QMK - -Una 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: - -```shell -git clone --recurse-submodules https://github.com/qmk/qmk_firmware.git -cd qmk_firmware -``` - -?> 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. - -QMK viene con un script para ayudarte a configurar el resto de cosas que necesitarás. Deberías ejecutarlo introduciendo este comando: - - util/qmk_install.sh - -## Prueba tu entorno de construcción - -Ahora 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: - - make <keyboard>:default - -Por ejemplo, para construir el firmware para un Clueboard 66% deberías usar: - - make clueboard/66/rev3:default - -Cuando esté hecho, deberías tener un montón de información de salida similar a esta: - -``` -Linking: .build/clueboard_66_rev3_default.elf [OK] -Creating load file for flashing: .build/clueboard_66_rev3_default.hex [OK] -Copying clueboard_66_rev3_default.hex to qmk_firmware folder [OK] -Checking file size of clueboard_66_rev3_default.hex [OK] - * The firmware size is fine - 26356/28672 (2316 bytes free) -``` - -# Creando tu keymap - -Ya 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 34fd7556bf..0000000000 --- a/docs/es/newbs_learn_more_resources.md +++ /dev/null @@ -1,15 +0,0 @@ -# Recursos de aprendizaje - -Estos recursos procuran dar miembros nuevos en la communidad QMK un mayor entendimiento de la información proporcionada en la documentación para novatos. - -Recursos de Git: - -* [Excelente tutorial general](https://www.codecademy.com/learn/learn-git) -* [Juego de Git para aprender usando ejemplos](https://learngitbranching.js.org/) -* [Recursos de Git para aprender más sobre GitHub](getting_started_github.md) -* [Recursos de Git dirigidos específicamente a QMK](contributing.md) - - -Recursos para línea de mandatos: - -* [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 69f6984658..0000000000 --- a/docs/es/newbs_testing_debugging.md +++ /dev/null @@ -1,101 +0,0 @@ -# Testeando y depurando - -Una 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. - -## Probando - -Probar 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. - -Nota: Estos programas no los provée ni están relacionados con QMK. - -* [Switch Hitter](https://elitekeyboards.com/switchhitter.php) (Sólo Windows) -* [Keyboard Viewer](https://www.imore.com/how-use-keyboard-viewer-your-mac) (Sólo Mac) -* [Keyboard Tester](https://www.keyboardtester.com) (Aplicación web) -* [Keyboard Checker](https://keyboardchecker.com) (Aplicación web) - -## Depurando - -Tu 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. - -```c -void keyboard_post_init_user(void) { - // Customise these values to desired behaviour - debug_enable=true; - debug_matrix=true; - //debug_keyboard=true; - //debug_mouse=true; -} -``` - -### Depurando con QMK Toolbox - -Para plataformas compatibles, [QMK Toolbox](https://github.com/qmk/qmk_toolbox) se puede usar para mostrar mensajes de depuración de tu teclado. - -### Depurando con hid_listen - -¿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. - -<!-- FIXME: Describe the debugging messages here. --> - -## Enviando tus propios mensajes de depuración - -A 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: - -```c -#include "print.h" -``` - -Después de eso puedes utilzar algunas funciones print diferentes: - -* `print("string")`: Imprime un string simple -* `uprintf("%s string", var)`: Imprime un string formateado -* `dprint("string")` Imprime un string simple, pero sólo cuando el modo de depuración está activo -* `dprintf("%s string", var)`: Imprime un string formateado, pero sólo cuando el modo de depuración está activo - -## Ejemplos de depuración - -Debajo 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). - -### ¿Que posición en la matriz tiene esta pulsación de tecla? - -Cuando 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 - -```c -bool process_record_user(uint16_t keycode, keyrecord_t *record) { - // If console is enabled, it will print the matrix position and status of each key pressed -#ifdef CONSOLE_ENABLE - uprintf("KL: kc: %u, col: %u, row: %u, pressed: %u\n", keycode, record->event.key.col, record->event.key.row, record->event.pressed); -#endif - return true; -} -``` - -Ejemplo de salida -```text -Waiting for device:....... -Listening: -KL: kc: 169, col: 0, row: 0, pressed: 1 -KL: kc: 169, col: 0, row: 0, pressed: 0 -KL: kc: 174, col: 1, row: 0, pressed: 1 -KL: kc: 174, col: 1, row: 0, pressed: 0 -KL: kc: 172, col: 2, row: 0, pressed: 1 -KL: kc: 172, col: 2, row: 0, pressed: 0 -``` - -### ¿Cuanto tiempo tardó en escanear la pulsación de una tecla? - -Cuando 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 - -```c -#define DEBUG_MATRIX_SCAN_RATE -``` - -Ejemplo de salida -```text - > matrix scan frequency: 315 - > matrix scan frequency: 313 - > matrix scan frequency: 316 - > matrix scan frequency: 316 - > matrix scan frequency: 316 - > matrix scan frequency: 316 -``` diff --git a/docs/fr-fr/ChangeLog/20190830.md b/docs/fr-fr/ChangeLog/20190830.md deleted file mode 100644 index cb223be31a..0000000000 --- a/docs/fr-fr/ChangeLog/20190830.md +++ /dev/null @@ -1,52 +0,0 @@ -# QMK Breaking Change - 30 août 2019 - -Quatre fois par an, QMK lance un processus pour fusionner les Breaking Changes. Un Breaking Change est un changement qui modifie la manière dont QMK fonctionne introduisant des incompatibilités ou des comportements dangereux. Nous n'effectuons ces changements que 4 fois par an afin que les utilisateurs n'aient pas peur de casser leurs keymaps en mettant à jour leur version de QMK. - -Ce document présente les fusions de Breaking Change. Voici la liste des changements. - -## Formattage de code Core avec clang-format - -* Tous les fichiers core (`drivers/`, `quantum/`, `tests/`, et `tmk_core/`) seront formatés avec clang-format -* Un processus travis pour reformatter les PRs lors de la fusion a été mis en place -* Vous pouvez utiliser la nouvelle commande CLI `qmk cformat` afin de formater avant de soumettre votre PR si vous le souhaitez. - -## Nettoyage des descripteurs LUFA USB - -* Nettoyage du code lié aux descripteurs USB HID sur les claviers AVR, afin de les rendre plus simple à lire et compréhensibles -* Plus d'information: https://github.com/qmk/qmk_firmware/pull/4871 -* Normalement pas de changement de fonctionnement et aucune keymap modifiée. - -## Migration des entrées de `ACTION_LAYER_MOMENTARY()` dans `fn_actions` vers des keycodes `MO()` - -* `fn_actions` est déprécié, et ses fonctionnalités ont été remplacées par des keycodes directs et `process_record_user()` -* Supprimer cette fonctionnalité obsolète devrait aboutir à une réduction importante de la taille du firmware et de la complexité du code -* Il est recommandé que toutes les keymaps affectées remplacent `fn_actions` vers les fonctionnalités de [keycode custom](https://docs.qmk.fm/#/custom_quantum_functions) et [macro](https://docs.qmk.fm/#/feature_macros) - -## Mise à jour Atreus vers les conventions de codage courantes - -* Les doublons include guards ont contourné le comportement de traitement des headers attendu -* Il est recommandé pour toutes les keymaps affectées de supprimer le doublon de `<keyboard>/config.h` et `<keyboard>/keymaps/<user>/config.h` et de ne garder que des surcharges au niveau keymap - -## Récupération des changements de fichier keymap langage de la fork ZSA - -* Corrige une issue dans le fichier `keymap_br_abnt2.h` qui inclut la mauvaise souce (`keymap_common.h` au lieu de `keymap.h`) -* Met à jour le fichier `keymap_swedish.h` afin d'être spécifique au suédois et plus "nordique" en général. -* Toutes les keymaps qui utilisent ceci devront supprimer `NO_*` et le remplacer par `SE_*`. - -## Mise à jour du repo afin d'utiliser LUFA comme un sous-module git - -* `/lib/LUFA` supprimé du dépôt -* LUFA, définis comme un sous-module, pointe vers qmk/lufa -* Ceci devrait ajouter plus de flexibilité vers LUFA, et nous permet de garder le sous-module à jour bien plus facilement. Il avait environ 2 ans de retard, sans manière simple de corriger. Ce changement devrait simplifier la mise à jour dans le futur. - -## Migration des entrées `ACTION_BACKLIGHT_*()` dans `fn_actions` vers des keycodes `BL_` - -* `fn_actions` est déprécié, et ses fonctionnalités ont été remplacées par des keycodes directs et `process_record_user()` -* Toutes les keymaps utilisant ces actions doivent avoir les clés `KC_FN*` remplacées par les clés `BL_*` équivalentes -* Si vous utilisez actuellement `KC_FN*` vous devrez remplacer `fn_actions` avec les fonctionnalités de [keycode custom](https://docs.qmk.fm/#/custom_quantum_functions) et [macro](https://docs.qmk.fm/#/feature_macros) - -## Remplacer l'alias `KC_DELT` par `KC_DEL` - -* `KC_DELT` était un alias redondant et non documenté pour `KC_DELETE` -* Il a été supprimé et toutes ses utilisations ont été remplacées par l'alias plus courant `KC_DEL` -* Environ 90 keymaps (surtout des boards ErgoDox) ont été modifiées à cette fin diff --git a/docs/fr-fr/README.md b/docs/fr-fr/README.md deleted file mode 100644 index 3d1f740abb..0000000000 --- a/docs/fr-fr/README.md +++ /dev/null @@ -1,31 +0,0 @@ -# Quantum Mechanical Keyboard Firmware - -[](https://github.com/qmk/qmk_firmware/tags) -[](https://discord.gg/Uq7gcHh) -[](https://docs.qmk.fm) -[](https://github.com/qmk/qmk_firmware/pulse/monthly) -[](https://github.com/qmk/qmk_firmware/) - -## Qu'est-ce que QMK Firmware? - -QMK (*Quantum Mechanical Keyboard*) est une communauté open source qui maintient le firmware QMK, la QMK Toolbox (*Boite à outil*), qmk.fm et leurs documentations. QMK Firmware est un firmware dédié aux claviers qui est basé sur [tmk\_keyboard](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é. - -## Comment l'obtenir - -Si vous souhaitez contribuer à une disposition de clavier (keymap), ou à des fonctionnalités de QMK alors le plus simple est de [forker le dépôt avec GitHub](https://github.com/qmk/qmk_firmware#fork-destination-box) puis cloner le dépôt localement pour y faire des changements. Vous pourrez pousser vos changements sur GitHub puis ouvrir un [Pull Request](https://github.com/qmk/qmk_firmware/pulls) depuis votre fork GitHub. - -Sinon, vous pouvez aussi le télécharger directement en ([zip](https://github.com/qmk/qmk_firmware/zipball/master), [tar](https://github.com/qmk/qmk_firmware/tarball/master)), ou le cloner avec git en ssh (`git@github.com:qmk/qmk_firmware.git`), ou https (`https://github.com/qmk/qmk_firmware.git`). - -## Comment le compiler - -Avant d'être prêt à compiler vous allez devoir [installer un environnement](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 : - - make planck/rev4:default - -Cette commande compilera la révision `rev4` du clavier `planck` avec la disposition `default`. Notez que tous les claviers n'ont pas forcément de révisions (aussi appelées sous-projects ou dossiers, ou en anglais «subprojects» ou «folder»). Cette option peut donc être omise: - - make preonic:default - -## Comment le personnaliser - -QMK a beaucoup de [fonctionnalités](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 25a593b2ec..0000000000 --- a/docs/fr-fr/_summary.md +++ /dev/null @@ -1,126 +0,0 @@ -**En Français** - -* [Guide pour débutant complet](fr-fr/newbs.md) - * [Pour débuter](fr-fr/newbs_getting_started.md) - * [Compiler son premier firmware](fr-fr/newbs_building_firmware.md) - * [Flasher le Firmware](fr-fr/newbs_flashing.md) - * [Test et Débuggage](fr-fr/newbs_testing_debugging.md) - * [Bonnes pratiques Git](fr-fr/newbs_best_practices.md) - * [Ressources d'apprentissage](fr-fr/newbs_learn_more_resources.md) - -* [Les bases de QMK](fr-fr/README.md) - * [Indroduction à QMK](fr-fr/getting_started_introduction.md) - * [QMK CLI](fr-fr/cli.md) - * [Configuration de la CLI QMK](fr-fr/cli_configuration.md) - * [Contribuer à QMK](fr-fr/contributing.md) - * [Comment utiliser GitHub](fr-fr/getting_started_github.md) - * [Trouver de l'aide](fr-fr/getting_started_getting_help.md) - -* [Breaking changes](fr-fr/breaking_changes.md) - * [30 août 2019](fr-fr/ChangeLog/20190830.md) - -* [FAQ](fr-fr/faq.md) - * [FAQ Générale](fr-fr/faq_general.md) - * [Compiler QMK](fr-fr/faq_build.md) - * [Débugguer / Dépanner QMK](fr-fr/faq_debug.md) - * [Keymap / Disposition](fr-fr/faq_keymap.md) - * [Installer les drivers avec Zadig](fr-fr/driver_installation_zadig.md) - -**En Anglais** - -* Guides détaillés - * [Installation des outils de compilation](fr-fr/getting_started_build_tools.md) - * [Guide Vagrant](fr-fr/getting_started_vagrant.md) - * [Commandes de compilations](fr-fr/getting_started_make_guide.md) - * [Flasher les firmwares](fr-fr/flashing.md) - * [Personnaliser les fonctionnalités](fr-fr/custom_quantum_functions.md) - * [Aperçu des fonctionnalités des dispositions](fr-fr/keymap.md) - -* [Hardware](fr-fr/hardware.md) - * [Processeurs AVR](fr-fr/hardware_avr.md) - * [Pilotes / Drivers](fr-fr/hardware_drivers.md) - -* Réferences - * [Lignes de conduite des claviers](fr-fr/hardware_keyboard_guidelines.md) - * [Options de configurations](fr-fr/config_options.md) - * [Keycodes / Codes des caractères](fr-fr/keycodes.md) - * [Conventions de codage - C](fr-fr/coding_conventions_c.md) - * [Conventions de codage - Python](fr-fr/coding_conventions_python.md) - * [Meilleurs pratiques sur la documentation](fr-fr/documentation_best_practices.md) - * [Modèles de documentation](fr-fr/documentation_templates.md) - * [Glossaire](fr-fr/reference_glossary.md) - * [Tests unitaires](fr-fr/unit_testing.md) - * [Fonctions utiles](fr-fr/ref_functions.md) - * [Support de configuration](fr-fr/reference_configurator_support.md) - * [Format du fichier info.json](fr-fr/reference_info_json.md) - * [Développer la CLI en Python](fr-fr/cli_development.md) - -* [Fonctionnalités](fr-fr/features.md) - * [Keycodes basiques](fr-fr/keycodes_basic.md) - * [Touches utilisées avec Shift (US ANSI)](fr-fr/keycodes_us_ansi_shifted.md) - * [Keycodes quantiques](fr-fr/quantum_keycodes.md) - * [Keycodes avancés](fr-fr/feature_advanced_keycodes.md) - * [Fonctionnalités audio](fr-fr/feature_audio.md) - * [Majuscule automatique](fr-fr/feature_auto_shift.md) - * [Rétroéclairage](fr-fr/feature_backlight.md) - * [Bluetooth](fr-fr/feature_bluetooth.md) - * [Bootmagic](fr-fr/feature_bootmagic.md) - * [Combos](fr-fr/feature_combo.md) - * [Commande](fr-fr/feature_command.md) - * [API anti-rebond](fr-fr/feature_debounce_type.md) - * [DIP Switch](fr-fr/feature_dip_switch.md) - * [Macros dynamiques](fr-fr/feature_dynamic_macros.md) - * [Interrupteurs rotatifs](fr-fr/feature_encoders.md) - * [Grave Escape](fr-fr/feature_grave_esc.md) - * [Retour haptique](fr-fr/feature_haptic_feedback.md) - * [Contrôleur LCD HD44780](fr-fr/feature_hd44780.md) - * [Touche à verrou / Lock-key](fr-fr/feature_key_lock.md) - * [Dispositions / layouts](fr-fr/feature_layouts.md) - * [Touche leader](fr-fr/feature_leader_key.md) - * [Matrice LED](fr-fr/feature_led_matrix.md) - * [Macros](fr-fr/feature_macros.md) - * [Boutons de souris](fr-fr/feature_mouse_keys.md) - * [Pilotes / Drivers OLED](fr-fr/feature_oled_driver.md) - * [Touche one-shot](fr-fr/one_shot_keys.md) - * [Périphériques de pointage](fr-fr/feature_pointing_device.md) - * [Souris PS/2](fr-fr/feature_ps2_mouse.md) - * [Éclairage RGB](fr-fr/feature_rgblight.md) - * [Matrice RGB](fr-fr/feature_rgb_matrix.md) - * [Space Cadet](fr-fr/feature_space_cadet.md) - * [Claviers scindés / splittés](fr-fr/feature_split_keyboard.md) - * [Stenographie](fr-fr/feature_stenography.md) - * [Inversion des mains](fr-fr/feature_swap_hands.md) - * [Tap Dance](fr-fr/feature_tap_dance.md) - * [Terminale](fr-fr/feature_terminal.md) - * [Imprimante thermique](fr-fr/feature_thermal_printer.md) - * [Caractères unicodes](fr-fr/feature_unicode.md) - * [Dossier utilisateur](fr-fr/feature_userspace.md) - * [Velocikey](fr-fr/feature_velocikey.md) - -* Pour les makers et les bricoleurs - * [Guide des claviers soudés à la main](fr-fr/hand_wire.md) - * [Guide de flash de l’ISP](fr-fr/isp_flashing_guide.md) - * [Guide du débogage ARM](fr-fr/arm_debugging.md) - * [Drivers I2C](fr-fr/i2c_driver.md) - * [Drivers SPI](fr-fr/spi_driver.md) - * [Contrôles des GPIO](fr-fr/internals_gpio_control.md) - * [Conversion en Proton C](fr-fr/proton_c_conversion.md) - -* Pour aller plus loin - * [Comment fonctionnent les claviers](fr-fr/how_keyboards_work.md) - * [Comprendre QMK](fr-fr/understanding_qmk.md) - -* Autres sujets - * [Utiliser Eclipse avec QMK](fr-fr/other_eclipse.md) - * [Utiliser VSCode avec QMK](fr-fr/other_vscode.md) - * [Support](fr-fr/getting_started_getting_help.md) - * [Comment ajouter des traductions](fr-fr/translating.md) - -* À l’intérieur de QMK (En cours de documentation) - * [Définitions](fr-fr/internals_defines.md) - * [Input Callback Reg](fr-fr/internals_input_callback_reg.md) - * [Appareils Midi](fr-fr/internals_midi_device.md) - * [Installation d’un appareil Midi](fr-fr/internals_midi_device_setup_process.md) - * [Utilitaires Midi](fr-fr/internals_midi_util.md) - * [Fonctions Midi](fr-fr/internals_send_functions.md) - * [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 4c3817d2ef..0000000000 --- a/docs/fr-fr/breaking_changes.md +++ /dev/null @@ -1,106 +0,0 @@ -# Breaking changes - -Ce document décrit le processus de QMK pour la gestion des breaking changes. Un breaking change est un changement qui modifie la manière dont QMK fonctionne introduisant des incompatibilités ou des comportements dangereux. Nous limitons ces changements afin que les utilisateurs n'aient pas peur de casser leurs keymaps en mettant à jour leur version de QMK. - -La période de breaking change est quand nous allons fusionner un PR qui change QMK d'une manière dangereuse ou inattendue. Il y a une période interne de test afin de nous assurer que les problèmes résiduels sont rares ou impossible à prévoir. - -## Qu'est-ce qui a été inclus dans des Breaking Changes précédents? - -* [30 août 2019](ChangeLog/20190830.md) - -## Quand va être le prochain Breaking Change? - -Le prochain Breaking Change est planifié pour le 29 novembre. - -### Dates importantes - -* [x] 21 septembre 2019 - `future` est créé. Il va être rebasé de manière hebdomadaire. -* [ ] 01 novembre 2019 - `future` fermé aux nouveaux PRs. -* [ ] 01 novembre 2019 - Appel aux testeurs. -* [ ] 27 novembre 2019 - `master` est bloqué, pas de PRs fusionnés. -* [ ] 29 novembre 2019 - `future` est fusionné dans `master`. -* [ ] 30 novembre 2019 - `master` est débloqué. Les PRs peuvent à nouveau être fusionnés. - -## Quels changements seront inclus? - -Pour voir une liste de candidats de breaking changes, vous pouvez regarder la liste des [labels `breaking_change`](https://github.com/qmk/qmk_firmware/pulls?q=is%3Aopen+label%3Abreaking_change+is%3Apr). De nouveaux changements peuvent être ajoutés entre maintenant et lorsque `future` est fermée, et un PR avec ce label n'est pas garanti d'être fusionné. - -Si vous souhaitez que votre breaking change soit inclus dans ce tour, vous devez créer un PR avec le label `breaking_change` et faire en sorte qu'il soit accepté avant que `future` ne soit fermé. Une fois `future` fermé, aucun nouveau breaking change sera accepté. - -Critère d'acceptation: - -* Le PR est complété et prêt à fusionner -* Le PR a un ChangeLog - -# Checklists - -Cette section documente plusieurs processus que nous utilisons en lançant le processus de Breaking Change. - -## Rebase `future` de `master` - -Ceci est lancé chaque vendredi tant que `future` est ouvert. - -Processus: - -``` -cd qmk_firmware -git checkout master -git pull --ff-only -git checkout future -git rebase master -git push --force -``` - -## Créer la branche `future` - -Ceci est fait immédiatement après la fusion de la branche `future` précédente. - -* `qmk_firmware` git commands - * [ ] `git checkout master` - * [ ] `git pull --ff-only` - * [ ] `git checkout -b future` - * [ ] Modifie `readme.md` - * [ ] Ajoute un message en haut qui indique que c'est une branche de test. - * [ ] Ajoute un lien vers ce document - * [ ] `git commit -m 'Branch point for <DATE> Breaking Change'` - * [ ] `git tag breakpoint_<YYYY>_<MM>_<DD>` - * [ ] `git tag <next_version>` # Evite que le label point d'arrêt soit confondu par un incrément de version - * [ ] `git push origin future` - * [ ] `git push --tags` - -## 4 Semaines Avant la Fusion - -* `future` est maintenant fermé aux nouveaux PRs, seul des correctifs pour les PRs courants peuvent être mergés -* Envoi de l'appel aux testeurs - * [ ] Discord - * [ ] GitHub PR - * [ ] https://reddit.com/r/olkb - -## 1 Semaine Avant la Fusion - -* Annonce que master sera fermée entre <2 jours avant> à <Jour de la fusion> - * [ ] Discord - * [ ] GitHub PR - * [ ] https://reddit.com/r/olkb - -## 2 Jours Avant la Fusion - -* Annonce que master est fermé pour 2 jours - * [ ] Discord - * [ ] GitHub PR - * [ ] https://reddit.com/r/olkb - -## Jour de la fusion - -* `qmk_firmware` git commands - * [ ] `git checkout future` - * [ ] `git pull --ff-only` - * [ ] `git rebase origin/master` - * [ ] Modifie `readme.md` - * [ ] Supprimer les notes à propos de `future` - * [ ] Regroupe ChangeLog dans un fichier. - * [ ] `git commit -m 'Merge point for <DATE> Breaking Change'` - * [ ] `git push origin future` -* Actions sur GitHub - * [ ] Crée un PR pour `future` - * [ ] Fusion le PR `future` diff --git a/docs/fr-fr/cli.md b/docs/fr-fr/cli.md deleted file mode 100644 index 917a9315bc..0000000000 --- a/docs/fr-fr/cli.md +++ /dev/null @@ -1,127 +0,0 @@ -# La CLI de QMK - -Cette page décrit comment configurer et utiliser la CLI QMK. - -# Vue d'ensemble - -La CLI de QMK permet de simplifier la compilation et l'interaction avec les claviers QMK. Nous avons défini plusieurs commandes pour simplifier et rationaliser les tâches telles qu'obtenir et compiler le firmware QMK, créer de nouvelles keymaps, et plus. - -* [CLI globale](#global-cli) -* [CLI locale](#local-cli) -* [Les commandes CLI](#cli-commands) - -# Pré-requis - -La CLI nécessite Python 3.5 ou plus récent. Nous essayons de limiter le nombre de pré-requis, mais vous allez aussi devoir installer les paquets listés dans le fichier [`requirements.txt`](https://github.com/qmk/qmk_firmware/blob/master/requirements.txt). - -# CLI globale - -QMK met à disposition une CLI installable qui peut être utilisée pour configurer votre environnement de compilation QMK, fonctionne avec QMK, et qui rend l'utilisation de plusieurs copies de `qmk_firmware` plus simple. Nous recommandons d'installer et de mettre à jour ceci régulièrement. - -## Installer en utilisant Homebrew (macOS, quelques Linux) - -Si vous avez installé [Homebrew](https://brew.sh) vous pouvez entrer ce qui suit et installer QMK: - -``` -brew tap qmk/qmk -brew install qmk -export QMK_HOME='~/qmk_firmware' # Optional, set the location for `qmk_firmware` -qmk setup # This will clone `qmk/qmk_firmware` and optionally set up your build environment -``` - -## Installer en utilisant easy_install ou pip - -Si votre système n'est pas listé ci-dessus, vous pouvez installer QMK manuellement. Premièrement, vérifiez que vous avez bien installé Python 3.5 (ou plus récent) et pip. Ensuite, installez QMK avec cette commande: - -``` -pip3 install qmk -export QMK_HOME='~/qmk_firmware' # Optional, set the location for `qmk_firmware` -qmk setup # This will clone `qmk/qmk_firmware` and optionally set up your build environment -``` - -## Paquets pour d'autres systèmes d'exploitation - -Nous recherchons des gens pour créer et maintenir un paquet `qmk` pour plus de systèmes d'exploitation. Si vous voulez créer un paquet pour votre système d'exploitation, suivez ces directives: - -* Suivez les bonnes pratiques pour votre système d'exploitation lorsqu'elles entrent en conflit avec ces directives - * Documentez pourquoi dans un commentaire lorsque vous ne les suivez pas -* Installez en utilisant un virtualenv -* Expliquez à l'utilisateur de définir la variable d'environnement `QMK_Home` pour "check out" les sources du firmware à un autre endroit que `~/qmk_firmware`. - -# Les commandes CLI - -## `qmk compile` - -Cette commande permet de compiler le firmware de n'importe quel répertoire. Vous pouvez compiler des exports JSON de <https://config.qmk.fm> ou compiler des keymaps du dépôt. - -**Utilisation pour les exports de configuration**: - -``` -qmk compile <configuratorExport.json> -``` - -**Utilisation pour les Keymaps**: - -``` -qmk compile -kb <keyboard_name> -km <keymap_name> -``` - -## `qmk format-c` - -Cette commande formatte le code C en utilisant clang-format. Lancez-la sans arguments pour formatter tout le code core, ou passez les noms de fichiers à la ligne de commande pour la lancer sur des fichiers spécifiques. - -**Utilisation**: - -``` -qmk format-c [file1] [file2] [...] [fileN] -``` - -## `qmk config` - -Cette commande vous permet de configurer le comportement de QMK. Pour la documentation complète de `qmk config`, regardez [Configuration de CLI](cli_configuration.md). - -**Utilisation**: - -``` -qmk config [-ro] [config_token1] [config_token2] [...] [config_tokenN] -``` - -## `qmk doctor` - -Cette commande examine votre environnement et vous alertes des potentiels problèmes de compilation ou de flash. - -**Utilisation**: - -``` -qmk doctor -``` - -## `qmk new-keymap` - -Cette commande crée une nouvelle keymap basée sur une keymap par défaut d'un clavier existant. - -**Utilisation**: - -``` -qmk new-keymap [-kb KEYBOARD] [-km KEYMAP] -``` - -## `qmk format-py` - -Cette commande formate le code python dans `qmk_firmware`. - -**Utilisation**: - -``` -qmk format-py -``` - -## `qmk pytest` - -Cette commande démarre la suite de test python. Si vous faites des changements dans le code Python, assurez-vous que les tests se lancent avec succès. - -**Utilisation**: - -``` -qmk pytest -``` diff --git a/docs/fr-fr/cli_configuration.md b/docs/fr-fr/cli_configuration.md deleted file mode 100644 index 3eed1e0e95..0000000000 --- a/docs/fr-fr/cli_configuration.md +++ /dev/null @@ -1,121 +0,0 @@ -# Configuration de QMK CLI - -Ce document explique comment fonctionne la commande `qmk config`. - -# Introduction - -La configuration pour QMK CLI est un système clé/valeur. Chaque clé est composée d'une sous-commande et d'un argument séparé par une virgule. Cela permet une traduction simple et directe entre les clés de configuration et l'argument qu'elle définit. - -## Exemple simple - -Comme exemple, regardons la commande `qmk compile --keyboard clueboard/66/rev4 --keymap default`. - -Il y a deux arguments de ligne de commande qui peuvent être lu de la configuration: - -* `compile.keyboard` -* `compile.keymap` - -Essayons de les définir: - -```shell -$ qmk config compile.keyboard=clueboard/66/rev4 compile.keymap=default -compile.keyboard: None -> clueboard/66/rev4 -compile.keymap: None -> default -Ψ Wrote configuration to '/Users/example/Library/Application Support/qmk/qmk.ini' -``` - -Maintenant, je peux lancer la commande `qmk compile` sans avoir à spécifier mon clavier et keymap à chaque fois. - -## Définir les options par défaut - -Parfois, il est utile de partager une configuration entre plusieurs commandes. Par exemple, plusieurs commandes prennent un argument `--keyboard`. Plutôt que de devoir définir cette valeur pour chaque commande, vous pouvez définir une valeur d'utilisateur qui sera utilisée par toutes les commandes qui prennent cet argument. - -Exemple: - -``` -$ qmk config user.keyboard=clueboard/66/rev4 user.keymap=default -user.keyboard: None -> clueboard/66/rev4 -user.keymap: None -> default -Ψ Wrote configuration to '/Users/example/Library/Application Support/qmk/qmk.ini' -``` - -# CLI Documentation (`qmk config`) - -La commande `qmk config` est utilisée pour interagir avec la configuration sous-jacente. Lancée sans argument, elle affiche la configuration courante. Lorsque des arguments sont définis, ils sont considérés comme étant des jetons de configuration, qui sont des chaînes de caractère ne contenant aucun espace avec le format suivant: - - <subcommand|general|default>[.<key>][=<value>] - -## Définir des valeurs de configuration - -Vous pouvez définir des valeurs de configuration en mettant le caractère égal (=) dans votre clé de configuration. La clé doit toujours être dans le format complet `<section>.<key>`. - -Exemple: - -``` -$ qmk config default.keymap=default -default.keymap: None -> default -Ψ Wrote configuration to '/Users/example/Library/Application Support/qmk/qmk.ini' -``` - -## Lire des valeurs de configuration - -Vous pouvez lire les valeurs de configuration pour la totalité de la configuration, une seule clé, ou une section entière. Vous pouvez aussi spécifier plusieurs clés pour afficher plus d'une valeur. - -### Exemple avec la totalité de la configuration - - qmk config - -### Exemple avec une section entière - - qmk config compile - -### Exemple avec une clé unique - - qmk config compile.keyboard - -### Exemple avec plusieurs clés - - qmk config user compile.keyboard compile.keymap - -## Supprimer des valeurs de configuration - -Vous pouvez supprimer une valeur de configuration en la définissant avec la chaîne spéciale `None`. - -Exemple: - -``` -$ qmk config default.keymap=None -default.keymap: default -> None -Ψ Wrote configuration to '/Users/example/Library/Application Support/qmk/qmk.ini' -``` - -## Plusieurs opérations - -Vous pouvez combiner plusieurs opérations d'écriture et de lecture en une seule commande. Elles seront exécutées et affichées dans l'ordre: - -``` -$ qmk config compile default.keymap=default compile.keymap=None -compile.keymap=skully -compile.keyboard=clueboard/66_hotswap/gen1 -default.keymap: None -> default -compile.keymap: skully -> None -Ψ Wrote configuration to '/Users/example/Library/Application Support/qmk/qmk.ini' -``` - -# Options de configuration utilisateur - -| Clé | Valeur par défaut | Description | -|-----|---------------|-------------| -| user.keyboard | None | Le chemin d'accès vers le clavier (Exemple: `clueboard/66/rev4`) | -| user.keymap | None | Le nom de la keymap (Exemple: `default`) | -| user.name | None | Le nom d'utilisateur GitHub de l'utilisateur. | - -# Toutes les options de configuration - -| Clé | Valeur par défaut | Description | -|-----|---------------|-------------| -| compile.keyboard | None | Le chemin d'accès vers le clavier (Exemple: `clueboard/66/rev4`) | -| compile.keymap | None | Le nom de la keymap (Exemple: `default`) | -| hello.name | None | Le nom à saluer lorsque démarré. | -| new_keyboard.keyboard | None | Le chemin d'accès vers le clavier (Exemple: `clueboard/66/rev4`) | -| new_keyboard.keymap | None | Le nom de la keymap (Example: `default`) | diff --git a/docs/fr-fr/contributing.md b/docs/fr-fr/contributing.md deleted file mode 100644 index d135871055..0000000000 --- a/docs/fr-fr/contributing.md +++ /dev/null @@ -1,154 +0,0 @@ -# Comment contribuer - -👍🎉 Premièrement, merci de prendre le temps de lire ceci et de contribuer! 🎉👍 - -Les contributions de tiers nous aide à améliorer et faire grandir QMK. Nous voulons rendre les pull requests et le processus de contribution utile et simple à la fois pour les contributeurs et les mainteneurs. C'est pourquoi nous avons mis en places des directives pour les contributeurs afin que votre pull request puisse être accepté sans changement majeur. - -* [Aperçu du projet](#project-overview) -* [Conventions de codage](#coding-conventions) -* [Directives générales](#general-guidelines) -* [Que veut dire le code de conduite pour moi?](#what-does-the-code-of-conduct-mean-for-me) - -## Je ne veux pas lire tout ce pavé! J'ai juste une question! - -Si vous voulez poser une question sur QMK, vous pouvez le faire sur le [sous-reddit OLKB](https://reddit.com/r/olkb) ou sur [Discord](https://discord.gg/Uq7gcHh). - -Merci de garder ceci en tête: - -* Cela peut prendre plusieurs heures pour que quelqu'un réponde à votre question. Merci d'être patient! -* Tous ceux impliqués avec QMK fait don de son temps et de son énergie. Nous ne sommes pas payés pour travailler sur ou répondre aux questions concernant QMK. -* Essayez de poser vos questions de manière à ce qu'elles soient le plus simple à répondre possible. Si vous n'êtes pas sûrs de savoir comment faire, voici quelques bon guides (en anglais): - * https://opensource.com/life/16/10/how-ask-technical-questions - * http://www.catb.org/esr/faqs/smart-questions.html - -# Aperçu du projet - -QMK est majoritairement écrit en C, avec quelques fonctions et parties spécifiques écrites en C++. Il est destiné aux processeurs intégrés que l'on trouve dans des clavier, particulièrement AVR ([LUFA](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. - -<!-- FIXME: We should include a list of resources for learning C here. --> - -# Où trouver de l'aide? - -Si vous avez besoin d'aide, vous pouvez [ouvrir une issue](https://github.com/qmk/qmk_firmware/issues) ou [un chat sur Discord](https://discord.gg/Uq7gcHh). - -# Comment contribuer? - -Vous n'avez encore jamais contribué à un projet open source? Vous vous demandez comment les contributions dans QMK fonctionnent? Voici un aperçu rapide! - -0. Enregistrez-vous sur [GitHub](https://github.com). -1. Définissez une keymap à contribuer, [trouvez une issue](https://github.com/qmk/qmk_firmware/issues) que vous souhaitez corriger, ou [une fonction](https://github.com/qmk/qmk_firmware/issues?q=is%3Aopen+is%3Aissue+label%3Afeature) que vous voulez ajouter. -2. Créez un fork sur le dépôt associé avec une issue sur votre compte GitHub. Cela veut dire que vous allez avoir une copie du dépôt sous `votre-login-GitHub/qmk_firmware`. -3. Clonez le dépôt sur votre machine locale en utilisant `git clone https://github.com/login-github/repository-name.git`. -4. Si vous travaillez sur une nouvelle fonctionnalité, pensez à ouvrir une issue pour parler avec nous du travail que vous souhaitez démarrer. -5. Créez une nouvelle branche pour votre correctif en utilisant `git checkout -b nom-de-branche`. -6. Faites les changements nécessaires pour corriger le problème ou ajouter la fonctionnalité. -7. Utilisez `git add chemin-de-fichier` pour ajouter les contenus des fichiers modifiés au "snapshot" que git utilise pour gérer l'état du projet, appelé aussi l'index. -8. Utilisez `git commit -m "Insérez une description courte des changements (en anglais)"` pour enregistrer le contenu de l'index avec un message descriptif. -9. Poussez les changements vers votre dépôt sur GitHub en utilisant `git push origin nom-de-branche`. -10. Créez un pull request sur [QMK Firmware](https://github.com/qmk/qmk_firmware/pull/new/master). -11. Donnez un titre à votre pull request en utilisant une description courte des changements que vous avez fait et ajoutez le numéro de l'issue ou du bug associé avec votre changement. Les commentaires de PR devraient se faire en anglais de préférence. Par exemple, vous pouvez utiliser un titre tel que celui-là: "Added more log outputting to resolve #4352". -12. Dans la description du pull request, expliquez les changements que vous avez fait et tous les problèmes qui existent, selon vous, sur le pull request que vous avez fait. Vous pouvez aussi utiliser la description pour poser des questions au mainteneur. Il n'est pas nécessaire que votre pull request soit parfait (aucun pull request ne l'est), le reviewer sera là pour vous aider à résoudre les problèmes et l'améliorer! -13. Attendez que le pull request soit revu par un mainteneur. -14. Faites des changements au pull request si le mainteneur le recommande. -15. Célébrez votre succès une fois votre pull request fusionné! - -# Conventions de codage - -La grande majorité de notre style est plutôt simple à comprendre. Si vous connaissez C ou Python, vous ne devriez pas avoir trop de difficulté avec notre style. - -* [Conventions de codage - C](coding_conventions_c.md) -* [Conventions de codage - Python](coding_conventions_python.md) - -# Directives générales - -Nous avons un certain nombre de type de changements dans QMK, chacun nécessitant un niveau de rigueur différent. Nous voulons que vous gardiez les directives suivantes en tête quel que soit le changement que vous êtes en train de faire. - -* Séparez les PR dans des unités logiques. Par exemple, ne soumettez pas un PR qui couvre deux fonctionnalités séparées, soumettez plutôt un PR pour chaque fonctionnalité. -* Vérifiez les espaces blancs non nécessaires avec `git diff --check` avant de commit. -* Assurez-vous que votre code compile. - * Keymaps: Assurez-vous que `make keyboard:your_new_keymap` ne renvoie pas d'erreur. - * Claviers: Assurez-vous que `make keyboard:all` ne renvoie pas d'erreur. - * Core: Assurez-vous que `make all` ne renvoie pas d'erreur. -* Assurez-vous que les messages de commit soient compréhensibles d'eux-mêmes. Vous devriez écrire une description simple (pas plus de 70 caractères) sur la première ligne, suivi d'une ligne vide, suivi d'un détail de votre commit, si nécessaire. Exemple: - -``` -Adjust the fronzlebop for the kerpleplork - -The kerpleplork was intermittently failing with error code 23. The root cause was the fronzlebop setting, which causes the kerpleplork to activate every N iterations. - -Limited experimentation on the devices I have available shows that 7 is high enough to avoid confusing the kerpleplork, but I'd like to get some feedback from people with ARM devices to be sure. -``` - -## Documentation - -La documentation est l'une des manières les plus simples de démarrer la contribution sur QMK. Il est simple de trouver des endroits où la documentation est fausse ou incomplète, et il est tout aussi simple de la corriger! Nous avons aussi grandement besoin de quelqu'un pour éditer notre documentation, donc si vous avez des compétences en édition mais que vous n'êtes pas sûr de savoir où aller, n'hésitez pas [demandez de l'aide](#where-can-i-go-for-help)! - -Vous trouverez toute notre documentation dans le répertoire `qmk_firmware/docs`, ou si vous préférez utiliser des outils web, vous pouvez cliquer sur le bouton "Suggest An Edit" en haut de chaque page sur https://docs.qmk.fm/. - -Lorsque vous donnez des exemples de code dans la documentation, essayez de suivre les conventions de nommage utilisées ailleurs dans la documentation. Par exemple, standardisez les enums en utilisant `my_layers` ou `my_keycodes` afin de garder une consistance: - -```c -enum my_layers { - _FIRST_LAYER, - _SECOND_LAYER -}; - -enum my_keycodes { - FIRST_LAYER = SAFE_RANGE, - SECOND_LAYER -}; -``` - -## Keymaps - -La plupart des contributeurs débutants démarrent avec leurs keymaps personnelles. Nous essayons de garder les standards pour les keymaps pluôt simple (les keymaps reflètent, après tout, la personnalité de leurs créateurs) mais nous demandons que vous suiviez les directives suivantes afin que d'autres puissent découvrir et apprendre de votre keymap. - -* Ecrivez un fichier `readme.md` en utilisant [la template](documentation_templates.md). -* Tous les PR de keymaps doivent être "squashés", donc si la manière dont vos commits sont squashés vous est important, vous devez le faire vous-même. -* Ne regroupez pas des fonctionnalités avec votre PR de keymap. Envoyez d'abord votre fonctionnalité, puis créez un second PR pour la keymap. -* N'incluez pas de fichier `Makefile` dans votre dossier de keymap (ils ne sont plus utilisés) -* Mettez à jour les copyrights dans les en-têtes de fichiers (cherchez `%YOUR_NAME%`) - -## Claviers - -Les claviers sont la raison d'être de QMK. Certains claviers sont maintenus par la communauté, alors que d'autre sont maintenus par les gens responsables de la création du clavier. Le fichier `readme.md` devrait vous informer de qui maintient le clavier. Si vous avez des questions concernant un clavier en particulier, vous pouvez [Ouvrir une issue](https://github.com/qmk/qmk_firmware/issues) et tagger le mainteneur dans votre question. - -Nous vous demandons aussi que vous suiviez ces directives: - -* Ecrivez un fichier `readme.md` en utilisant [le template](documentation_templates.md). -* Gardez un nombre de commits raisonnable, ou nous squasherons votre PR. -* Ne regroupez pas des fonctionnalités avec le PR pour votre clavier. Envoyez d'abord votre fonctionnalité, puis créez un second PR pour le clavier. -* Appelez les fichiers `.c`/`.h` du nom du dossier parent, par exemple `/keyboards/<kb1>/<kb2>/<kb2>.[ch]` -* N'incluez pas de fichier `Makefile` dans votre dossier de keymap (ils ne sont plus utilisés) -* Mettez à jour les copyrights dans les en-têtes de fichiers (cherchez `%YOUR_NAME%`) - -## Quantum/TMK Core - -Faites attention d'être sûr d'implémenter votre nouvelle fonctionnalité de la meilleure manière qu'il soit avant d'investir beaucoup de travail à son développement. Vous pouvez apprendre les bases de QMK en lisant [Comprendre QMK](understanding_qmk.md), qui vous donnera une idée du flux du programme QMK. A partir de là, parlez nous afin de définir la meilleure façon d'implémenter votre idée. Il y a deux façons principale de le faire: - -* [Chat sur Discord](https://discord.gg/Uq7gcHh) -* [Ouvrir une Issue](https://github.com/qmk/qmk_firmware/issues/new) - -Les PR de nouvelles fonctionnalités de de correction de bug affectent tous les claviers. Nous sommes aussi dans un processus de restructuration de QMK. Pour cette raison, il est absolument nécessaire que tout changement important ou significatif soit discuté avant que l'implémentation soit faite. Si vous ouvrez un PR sans nous avoir parlé, préparez-vous à faire des refontes significatives si vos changements ne sont pas compatibles avec ce que nous avons planifié. - -Voici quelques choses à garder en tête lorsque vous travaillez sur une fonctionnalité ou un bug fix. - -* **Désactivé par défaut** - la mémoire est plutôt limitée sur la plupart des puces que QMK supporte, et il est important que les keymaps courantes ne soient pas cassées. S'il vous plaît faites que vos features doivent être **activées** plutôt que désactivées. Si vous pensez qu'elle devrait être activée par défaut, ou que cela réduit la taille du code, parlez-nous-en. -* **Compilez localement avant de soumettre** - Cela devrait aller sans dire, mais votre code doit compiler! Vous devriez toujours faire gaffe à ce que vos changements compilent avant d'ouvrir une pull request. -* **Faites attention aux révisions et différentes bases de puces** - beaucoup de claviers ont des révisions qui permettent des changements de configuration mineurs, voir des bases de chip différentes. Essayez de faire que votre fonctionnalité soit supportée à la fois sur ARM et AVR, ou désactivez-là automatiquement sur les plateformes non supportées. -* **Expliquez votre fonctionnalité** - Documentez-là dans `docs/`, soit dans un nouveau fichier, ou dans une partie d'un fichier existant. Si vous ne la documentez pas, personne ne pourra bénéficier de votre dur labeur. - -Nous vous demandons aussi de suivre ces directives: - -* Gardez un nombre de commits raisonnable, ou nous squasherons votre PR. -* Ne regroupez pas des claviers ou des keymaps avec des changements core. Soumettez vos changements core en premier. -* Ecrivez des [Tests Unitaires](unit_testing.md) pour votre fonctionnalité. -* Suivez le style du fichier que vous modifiez. Si le style n'est pas clair ou qu'il y a un mélange de fichiers, vous devriez vous conformer aux [conventions de codage](#coding-conventions) au dessus. - -## Refactoriser - -Afin de maintenir une vision claire sur comment les choses sont architectuées dans QMK, nous essayons de planifier des refactorisations en profondeur et qu'un collaborateur fasse le changement. Si vous avez une idée de refactorisation, ou une suggestion, [ouvrez une issue] [open an issue](https://github.com/qmk/qmk_firmware/issues), nous adorons discuter de comment améliorer QMK. - -# Que veut dire le code de conduite pour moi? - -Note [Code De Conduite](https://github.com/qmk/qmk_firmware/blob/master/CODE_OF_CONDUCT.md) veut dire que vous avez la responsabilité de traiter tout le monde dans le projet avec respect et courtoisie, peu importe leur identité. Si vous êtes victime d'une attitude ou de commentaires inappropriés, tels que décrit dans notre Code de Conduite, nous sommes là pour vous et nous ferons de notre mieux pour nous assurer que le fautif soit réprimandé, tel que décrit dans notre code. diff --git a/docs/fr-fr/driver_installation_zadig.md b/docs/fr-fr/driver_installation_zadig.md deleted file mode 100644 index 35beefa3c9..0000000000 --- a/docs/fr-fr/driver_installation_zadig.md +++ /dev/null @@ -1,46 +0,0 @@ -# Installation du driver du bootloader avec Zadig - -Vous 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. - -Il 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. - -Nous 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. - -## Installation - -Passez 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. -Certains 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. - -Pour 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. - -Zadig 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**. - - - - Pour les claviers avec des MCUs Atmel AVR, le bootloader aura un nom similaire à `ATm32U4DFU`, et un Vendor ID `03EB`. - - Les bootloaders USBasp s'appelleront `USBasp`, avec un VID/PID `16C0:05DC`. - - Les claviers AVR flashé avec le bootloader QMK-DFU s'appelleront `<nom du clavier> Bootloader` et auront aussi le VID `03EB`. - - Pour la plupart des claviers ARM, ils s'appelleront `STM32 BOOTLOADER`, et auront un VID/PID `0483:DF11`. - -!> 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!** - -Si 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. - - - -Finalement, 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. - -## Récupérer l'installation du mauvais périphérique - -Si 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 : - - - -Ouvrez le Gestionnaire de périphériques et cherchez un périphérique qui ressemble à votre clavier. - - - -Cliquez 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. - - - -Appuyez 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 89576b3cc2..0000000000 --- a/docs/fr-fr/faq.md +++ /dev/null @@ -1,6 +0,0 @@ -# Foire Aux Questions - -* [FAQ Générale](faq_general.md) -* [Construire ou Compiler QMK](faq_build.md) -* [Débuguer et Dépanner QMK](faq_debug.md) -* [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 c6a3253530..0000000000 --- a/docs/fr-fr/faq_build.md +++ /dev/null @@ -1,154 +0,0 @@ -# Foire aux questions sur la compilation - -Cette 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). - -## Je ne peux pas programmer sous Linux - -Vous 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). - -Un exemple utilisant `sudo`, lorsque votre contrôleur est un ATMega32u4 : - - $ sudo dfu-programmer atmega32u4 erase --force - $ sudo dfu-programmer atmega32u4 flash your.hex - $ sudo dfu-programmer atmega32u4 reset - -ou simplement : - - $ sudo make <keyboard>:<keymap>:dfu - -Veuillez 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. - -### Règles `udev` pour Linux - -Sous 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: - -```console -sudo udevadm control --reload-rules -sudo udevadm trigger -``` - -**/etc/udev/rules.d/50-atmel-dfu.rules:** -``` -# Atmel ATMega32U4 -SUBSYSTEMS=="usb", ATTRS{idVendor}=="03eb", ATTRS{idProduct}=="2ff4", MODE:="0666" -# Atmel USBKEY AT90USB1287 -SUBSYSTEMS=="usb", ATTRS{idVendor}=="03eb", ATTRS{idProduct}=="2ffb", MODE:="0666" -# Atmel ATMega32U2 -SUBSYSTEMS=="usb", ATTRS{idVendor}=="03eb", ATTRS{idProduct}=="2ff0", MODE:="0666" -``` - -**/etc/udev/rules.d/52-tmk-keyboard.rules:** -``` -# tmk keyboard products https://github.com/tmk/tmk_keyboard -SUBSYSTEMS=="usb", ATTRS{idVendor}=="feed", MODE:="0666" -``` - -**/etc/udev/rules.d/54-input-club-keyboard.rules:** - -``` -# Input Club keyboard bootloader -SUBSYSTEMS=="usb", ATTRS{idVendor}=="1c11", MODE:="0666" -``` - -**/etc/udev/rules.d/55-catalina.rules:** -``` -# ModemManager should ignore the following devices -ATTRS{idVendor}=="2a03", ENV{ID_MM_DEVICE_IGNORE}="1" -ATTRS{idVendor}=="2341", ENV{ID_MM_DEVICE_IGNORE}="1" -``` - -**Note:** Le filtrage utilisant ModemManager fonctionnera uniquement si vous n'êtes pas en mode strict. Les commandes suivantes peuvent changer cette option : - -```console -sudo sed -i 's/--filter-policy=strict/--filter-policy=default/' /lib/systemd/system/ModemManager.service -sudo systemctl daemon-reload -sudo systemctl restart ModemManager -``` - -**/etc/udev/rules.d/56-dfu-util.rules:** - -``` -# stm32duino -SUBSYSTEMS=="usb", ATTRS{idVendor}=="1eaf", ATTRS{idProduct}=="0003", MODE:="0666" -# Generic stm32 -SUBSYSTEMS=="usb", ATTRS{idVendor}=="0483", ATTRS{idProduct}=="df11", MODE:="0666" -``` - -### Le périphérique sériel n'est pas détecté en mode bootloader sous Linux - -Assurez-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. - -## Périphérique inconnu pour le bootloader DFU - -Les 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. - -Relancer 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). - -Si 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. - -## USB VID et PID - -Vous pouvez utiliser l'ID de votre choix en modifier `config.h`. Il y a peu de chance de conflit avec d'autres produits. - -La plupart des boards QMK utilisent `0xFEED` comme vendor ID. Vérifiez les autres claviers pour être sûr de choisir un Product ID unique. - -Étudiez aussi ce ticket -https://github.com/tmk/tmk_keyboard/issues/150 - -Vous pouvez acheter un VID:PID unique ici. Je ne pense pas que ce soit nécessaire pour un usage personnel. -- https://www.obdev.at/products/vusb/license.html -- https://www.mcselec.com/index.php?page=shop.product_details&flypage=shop.flypage&product_id=92&option=com_phpshop&Itemid=1 - -## BOOTLOADER_SIZE pour AVR - -Notez que la taille du bootloader pour les Teensy2.0++ est de 2048bytes. Quelques Makefiles peuvent contenir une erreur et avoir le mauvais commentaire. - -``` -# Boot Section Size in *bytes* -# Teensy halfKay 512 -# Teensy++ halfKay 2048 -# Atmel DFU loader 4096 (TMK Alt Controller) -# LUFA bootloader 4096 -# USBaspLoader 2048 -OPT_DEFS += -DBOOTLOADER_SIZE=2048 -``` - -## `avr-gcc: internal compiler error: Abort trap: 6 (program cc1)` sous MacOS - -C'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. - -La solution est de supprimer et réinstaller tous les modules affectés. - -``` -brew rm avr-gcc -brew rm dfu-programmer -brew rm dfu-util -brew rm gcc-arm-none-eabi -brew rm avrdude -brew install avr-gcc -brew install dfu-programmer -brew install dfu-util -brew install gcc-arm-none-eabi -brew install avrdude -``` - -### avr-gcc 8.1 et LUFA - -Si vous avez mis à jour votre avr-gcc au-dessus de la version 7, vous risquez de voir des erreurs impliquant LUA. Par exemple : - -`lib/lufa/LUFA/Drivers/USB/Class/Device/AudioClassDevice.h:380:5: error: 'const' attribute on function returning 'void'` - -Pour le moment, vous devrez revenir à la version 7 de avr-gcc dans brew. - -``` -brew uninstall --force avr-gcc -brew install avr-gcc@8 -brew link --force avr-gcc@8 -``` - -### 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) - -A 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. - -[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. -Si 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 8868744f73..0000000000 --- a/docs/fr-fr/faq_debug.md +++ /dev/null @@ -1,153 +0,0 @@ -# FAQ Débugage - -Cette page détaille diverses questions fréquemment posées par les utilisateurs sur le dépannage de leurs claviers. - -# Console de débugage - -## `hid_listen` ne reconnaît pas de périphérique - -Lorsque la console de débugage sur votre périphérique n'est pas prêt, vous obtiendrez un message similaire: - -``` -Waiting for device:......... -``` - -Une fois le périphérique connecté, *hid_listen* le trouve et vous obtiendrez ce message: - -``` -Waiting for new device:......................... -Listening: -``` - -Si vous ne recevez pas ce message `Listening:`, essayez de compiler avec `CONSOLE_ENABLE=yes` dans le [Makefile] - -Il se peut que vous ayez besoin de certains privilèges avancés pour accéder à des périphériques sur des OS comme Linux. - -- Essayez `sudo hid_listen` - -## Ne reçoit pas de messages sur la console - -Vérifiez : - -- *hid_listen* trouve votre périphérique. Voir ci-dessus. -- Activez le débugage en appuyant sur **Magic**+d. Voir [Commandes Magic](https://github.com/tmk/tmk_keyboard#magic-commands). -- Définissez `debug_enable=true` en général dans `matrix_init()` du fichier **matrix.c**. -- Essayez d'utiliser la fonction `print` à la place du debug print. Voir **common/print.h**. -- Déconnectez tous les autres périphériques qui utilisent la fonction console. Voir [Issue #97](https://github.com/tmk/tmk_keyboard/issues/97). - -## Linux ou les systèmes UNIX nécessitent des privilèges super utilisateur - -Utilisez `sudo` pour exécuter *hid_listen* avec des privilèges étendus. - -``` -$ sudo hid_listen -``` - -Ou 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. - -Fichier: /etc/udev/rules.d/52-tmk-keyboard.rules(sous Ubuntu) -``` -# tmk keyboard products https://github.com/tmk/tmk_keyboard -SUBSYSTEMS=="usb", ATTRS{idVendor}=="feed", MODE:="0666" -``` - -*** - -# Divers - -## Considérations de sécurité - -Vous 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é. - -- 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. -- Modifier les fichiers tmk_core / common peut rendre le clavier inutilisable -- 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. -- Pour finir, notez que la taille maximale d'un fichier .hex sur un Plank est de 7000h (28672 decimal) - -``` -Linking: .build/planck_rev4_cbbrowne.elf [OK] -Creating load file for Flash: .build/planck_rev4_cbbrowne.hex [OK] - -Size after: - text data bss dec hex filename - 0 22396 0 22396 577c planck_rev4_cbbrowne.hex -``` - -- La taille du fichier ci-dessus est de 22396/577ch, ce qui est en dessous de 28672/7000h -- Tant que vous avez un fichier .hex alternatif correct, vous pouvez réessayer en le chargeant -- 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. -- 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. -- 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. - -## NKRO ne fonctionne pas - -Premièrement, vous devez compiler le firmware avec l'option de compilation `NKRO_ENABLE` dans le **Makefile**. - -Essayez 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. - -## Le TrackPoint a besoin Circuit de réinitialisation (Support de souris PS/2) - -Sans 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. - -- https://geekhack.org/index.php?topic=50176.msg1127447#msg1127447 -- https://www.mikrocontroller.net/attachment/52583/tpm754.pdf - -## Impossible de lire la colonne de la matrice après 16 - -Utilisez `1UL<<16` à la place de `1<<16` dans `read_cols()` du fichier [matrix.h] lorsque le nombre de vos colonnes dépassent 16. - -En 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`. - -https://deskthority.net/workshop-f7/rebuilding-and-redesigning-a-classic-thinkpad-keyboard-t6181-60.html#p146279 - -## Les touches spéciales ne fonctionnent pas (Touche Système, Touches de contrôle du son) - -Vous devez définir `EXTRAKEY_ENABLE` dans le fichier `rules.mk` pour les utiliser dans QMK. - -``` -EXTRAKEY_ENABLE = yes # Audio control and System control -``` - -## Réveiller du mode veille ne fonctionne pas - -Sous 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. - -Appuyer sur n'importe quelle touche en mode veille devrait sortir l'ordinateur de veille. - -## Vous utilisez un Arduino? - -**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. - -- https://arduino.cc/en/uploads/Main/arduino-leonardo-schematic_3b.pdf -- https://arduino.cc/en/uploads/Main/arduino-micro-schematic.pdf - -Les Arduino Leonardo et micro ont des **ATMega32U4** et peuvent être utilisés avec TMK, mais le bootloader Arduino peut causer des problèmes. - -## Activer JTAG - -Par 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. - -Si vous voulez garder JTAG activé, ajoutez la ligne suivante à votre fichier `config.h` : - -```c -#define NO_JTAG_DISABLE -``` - -## Compatibilité USB 3 - -Il semble que certaines personnes ont eu des problèmes avec les ports USB 3, essayez un port USB 2. - -## Compatibilité Mac - -### OS X 10.11 et Hub - -https://geekhack.org/index.php?topic=14290.msg1884034#msg1884034 - -## Problème sur BIOS (UEFI) / Resume (Mise en veille et réveil) / Redémarrage - -Certaines personnes ont eu des problèmes de fonctionnement de leur clavier dans le BIOS et/ou après des redémarrages. - -Pour 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. - -https://github.com/tmk/tmk_keyboard/issues/266 -https://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 b1eae6df16..0000000000 --- a/docs/fr-fr/faq_general.md +++ /dev/null @@ -1,16 +0,0 @@ -# Questions fréquemment posées - -## Qu'est-ce que QMK ? - -[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). - -## Quelles sont les différences entre QMK et TMK ? - -TMK 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. - -D'un point de vue technique, QMK se base sur TMK en lui ajoutant plusieurs nouvelles fonctionnalités. -QMK 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). - -D'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. - -Les 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 cc0700ab8e..0000000000 --- a/docs/fr-fr/faq_keymap.md +++ /dev/null @@ -1,161 +0,0 @@ -# FAQ Keymap - -Cette 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). - -## Quels Keycodes puis-je utiliser ? - -Regardez [Keycodes](keycodes.md) pour une liste des keycodes disponibles. Certains keycodes spécifiques ont des documentations plus complètes de disponible. - -Les keycodes sont définies dans [common/keycode.h](https://github.com/qmk/qmk_firmware/blob/master/quantum/keycode.h). - -## Quels sont les keycodes par défaut ? - -Il 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 : - -<!-- Source for this image: https://www.keyboard-layout-editor.com/#/gists/bf431647d1001cff5eff20ae55621e9a --> - - -## Certaines de mes touches sont permutées ou ne fonctionnent pas - -QMK 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. - -Pour 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: - -* [Bootmagic](feature_bootmagic.md) -* [Command](feature_command.md) - -## La touche de menu ne fonctionne pas - -La 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`. - -## `KC_SYSREQ` ne fonctionne pas - -Utilisez 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'. - -Voir [issue #168](https://github.com/tmk/tmk_keyboard/issues/168) et -* https://en.wikipedia.org/wiki/Magic_SysRq_key -* https://en.wikipedia.org/wiki/System_request - -## Les touches alimentation ne fonctionnent pas - -Un 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. - -Le 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. - -## Modificateur "One Shot" - -Cette 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. - -https://github.com/tmk/tmk_keyboard/issues/67 - -## Le modificateur d'un calque reste bloqué - -Les touches de modification ou les calques peuvent être bloquées si la commutation de calque n'est pas configurée correctement. -Pour 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. - -* https://github.com/tmk/tmk_core/blob/master/doc/keymap.md#31-momentary-switching -* https://geekhack.org/index.php?topic=57008.msg1492604#msg1492604 -* https://github.com/tmk/tmk_keyboard/issues/248 - -## Support de touche à verrouillage mécanique - -Cette 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`: - -``` -#define LOCKING_SUPPORT_ENABLE -#define LOCKING_RESYNC_ENABLE -``` - -Une fois la fonction activée, utilisez les keycodes `KC_LCAP`, `KC_LNUM` et `KC_LSCR` dans votre keymap. - -Des 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`.*** - -## Ajouter des caractères spéciaux autres que ASCII comme la cédille 'Ç' - -Voir la fonctionnalité [Unicode](feature_unicode.md). - -## Touche `Fn` sur macOS - -Contrairement à 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. - -Il 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. -Pire 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. - -Voir [cette issue](https://github.com/qmk/qmk_firmware/issues/2179) pour des informations détaillées. - -## Touches Media sous Mac OSX - -#### KC_MNXT et KC_MPRV ne fonctionnent pas sous Mac - -Utilisez `KC_MFFD`(`KC_MEDIA_FAST_FORWARD`) et `KC_MRWD`(`KC_MEDIA_REWIND`) à la place de `KC_MNXT` et `KC_MPRV`. -Voir https://github.com/tmk/tmk_keyboard/issues/195 - -## Touches supportées sous Mac OSX? - -Vous pouvez connaître les keycodes supportés par OSX en lisant ce code source. - -`usb_2_adb_keymap` contient les tableaux des pages Keyboard/Keypad vers les scancodes ADB (keycodes interne à OSX). - -https://opensource.apple.com/source/IOHIDFamily/IOHIDFamily-606.1.7/IOHIDFamily/Cosmo_USB2ADB.c - -Et `IOHIDConsumer::dispatchConsumerEvent` s'occupe des utilisations Consumer page. - -https://opensource.apple.com/source/IOHIDFamily/IOHIDFamily-606.1.7/IOHIDFamily/IOHIDConsumer.cpp - -## Touches JIS dans Mac OSX - -Les 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. - -* Activer la touche NFER sur clavier PC -* Activer la touche XFER sur clavier PC -* Activer la touche KATAKANA sur clavier PC - -https://pqrs.org/osx/karabiner/seil.html - -## RN-42 Bluetooth ne fonctionne pas avec Karabiner - -Karabiner - 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. -https://github.com/tekezo/Karabiner/issues/403#issuecomment-102559237 - -Plus de détails sur ce problème sur les liens suivants. -https://github.com/tmk/tmk_keyboard/issues/213 -https://github.com/tekezo/Karabiner/issues/403 - -## Esc et <code>`</code> sur une touche simple. - -Cette 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. - -Voir la fonctionnalité [Grave Escape](feature_grave_esc.md). - -## Eject sur Mac OSX - -Le keycode`KC_EJCT` fonctionne sous OSX. https://github.com/tmk/tmk_keyboard/issues/250 - -Il semble que Windows 10 ignore le code et Linux/Xorg le reconnaît mais n'a pas de mapping par défaut. - -Nous 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. - -## Qu'est-ce que `weak_mods` et `real_mods` dans `action_util.c` - -___TO BE IMPROVED___ - -real_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. - -Par exemple, disons que vous maintenez la touche physique "shift gauche" et tapez ACTION_MODS_KEY(LSHIFT, KC_A), - -en weak_mods, - -* (1) maintenir shift gauche : real_mods |= MOD_BIT(LSHIFT) -* (2) appuyer ACTION_MODS_KEY(LSHIFT, KC_A): weak_mods |= MOD_BIT(LSHIFT) -* (3) lâcher ACTION_MODS_KEY(LSHIFT, KC_A): weak_mods &= ~MOD_BIT(LSHIFT) -real_mods garde sur état modificateur. - -sans weak_mods, - -* (1) maintenir shift gauche : real_mods |= MOD_BIT(LSHIFT) -* (2) appuyer ACTION_MODS_KEY(LSHIFT, KC_A): real_mods |= MOD_BIT(LSHIFT) -* (3) lâcher ACTION_MODS_KEY(LSHIFT, KC_A): real_mods &= ~MOD_BIT(LSHIFT) -ici real_mods a perdu son état pour 'shift gauche physique'. - -weak_mods est ORed avec real_mods lorsque le rapport du clavier est envoyé. -https://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 9f5493194a..0000000000 --- a/docs/fr-fr/flashing.md +++ /dev/null @@ -1,238 +0,0 @@ -# Instructions pour flasher et informations sur les bootloader - -Les claviers utilisent différents types de bootloaders et certains doivent être flashés différement. Heureusement, certains projets comme la [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases) ont pour objectifs de permettre de flasher les différents bootloader sans trop se faire de soucis et ça peu importe les manières de les flasher. - -Si vous avez un bootloader sélectionné avec la variable `BOOTLOADER` dans votre fichier `rules.mk` alors QMK vas automatiquement calculer si votre fichier .hex n'est pas trop grand pour être flashé sur votre appareil, et il affichera la taille finale du firmware. Pour vérifier la taille manuellement, vous pouvez aussi compiler le firmware avec l'option `check-size`. Exemple : `make planck/rev4:default:check-size`. - -## DFU - -Le bootloader pour les processeurs Atmel DFU est fourni par défaut sur tous les processeurs atmega32u4. Celui-ci est utilisé par beaucoup de claviers plus vieux que les OLKB et Clueboard qui ont leur propre ICs sur leurs PCBs. D'autres claviers utilisent le bootloader DFU de LUFA (ou son fork QMK), notamment les nouveaux claviers OLKB. Ce dernier ajoute des fonctionnalités spécifiques sur le matériel. - -Pour vérifier la compatibilité avec le bootloader DFU, vérifiez que ce bloc de code est présent dans votre fichier `rules.mk`. Parfois il peut être inscrit `lufa-dfu` ou `qmk-dfu` à la place. - -```make -# Bootloader selection -# Teensy halfkay -# Pro Micro caterina -# Atmel DFU atmel-dfu -# LUFA DFU lufa-dfu -# QMK DFU qmk-dfu -# ATmega32A bootloadHID -# ATmega328P USBasp -BOOTLOADER = atmel-dfu -``` - -Méthodes de flash compatibles : - -* [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases) (interface graphique recommandé) -* [dfu-programmer](https://github.com/dfu-programmer/dfu-programmer) / `:dfu` avec QMK (outil en ligne de commande recommandé) - -Ordre des actions: - -1. Pressez le keycode `RESET`, ou appuyez sur le bouton physique RESET ou alors créez un contact entre RST et GND. -2. Attendez que l'OS detecte l'appareil. -3. Éffacez la mémoire, cela peut être fait automatiquement. -4. Flasher le fichier .hex. -5. Redémarrez l'appareil en mode «application», cela peut être fait automatiquement. - -Alternativement: - - make <keyboard>:<keymap>:dfu - -### DFU QMK - -QMK a un fork du bootloader LUFA DFU qui vous permet de faire un simple scan de la matrice pour quitter le bootloader et retourner à l'application. En même temps que le flash se produira, il est possible de faire flasher un led ou de produire un son via un haut parleur. Pour activer ces fonctionnalités, vous pouvez utiliser ce bloc dans votre fichier `config.h` (La touche permettant de quitter le bootloader a besoin d'être reliée entre les ports définis en INPUT et OUTPUT ici): - - #define QMK_ESC_OUTPUT F1 // usually COL - #define QMK_ESC_INPUT D5 // usually ROW - #define QMK_LED E6 - #define QMK_SPEAKER C6 - -Le fabricant et le nom du produit proviennent de vos définitions dans fichier `config.h`, et la chaîne de caractère «bootloader» est ajoutée au nom du produit. - -Pour génerer le bootloader, utilisez la cible `bootloader`. Exemple: `make planck/rev4:default:bootloader`. - -Pour génerer un fichier .hex prêt pour la production qui contiendra tant l'application que le bootloader, utilisez la cible `production`. Exemple: `make planck/rev4:default:production`. - -### Commandes DFU - -Il y a plusieurs commandes DFU que vous pouvez utiliser pour flasher le firmware sur un appareil DFU. - -* `:dfu` - C'est l'option normale qui attend qu'un appareil DFU soit disponible et qui flashe le firmware dès que c'est le cas. La vérification sera faite toutes les 5 secondes. -* `:dfu-ee` - Cette option flash un fichier `.eep` à la place d'un fichier `.hex`. Ce cas est plutôt rare. -* `:dfu-split-left` - Cette option flashe le firmware normal comme avec l'option (`:dfu`). Mais cela aussi flash le coté gauche du fichier EEPROM pour les claviers scindés. _C'est l'option idéale pour un clavier scindé basé sur le Elite C_ -* `:dfu-split-right` - Cette option flashe le firmware normal comme avec l'option (`:dfu`). Mais cela aussi flash le coté droite du fichier EEPROM pour les claviers scindés. _C'est l'option idéale pour un clavier scindé basé sur le Elite C_ - -## Caterina - -Les cartes arduinos et leurs clones utilisent le [bootloader Caterina](https://github.com/arduino/ArduinoCore-avr/tree/master/bootloaders/caterina) (tous les claviers utilisant un Pro Micro, ou un clone). Ils utilisent aussi le protocole avr109 pour communiquer en virtuellement en série (serial en anglais). Les bootloaders comme le [A-Star](https://www.pololu.com/docs/0J61/9) sont basés sur Caterina. - -Pour vérifier la compatibilité avec un bootloader Caterina, vérifiez que ce bloc est présent dans votre fichier `rules.mk`: - -```make -# Bootloader selection -# Teensy halfkay -# Pro Micro caterina -# Atmel DFU atmel-dfu -# LUFA DFU lufa-dfu -# QMK DFU qmk-dfu -# ATmega32A bootloadHID -# ATmega328P USBasp -BOOTLOADER = caterina -``` - -Flashers compatibles: - -* [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases) (Interface graphique recommandée) -* [avrdude](https://www.nongnu.org/avrdude/) avec avr109 / `:avrdude` (Outil en ligne de commande recommandé) -* [AVRDUDESS](https://github.com/zkemble/AVRDUDESS) - -Séquence de flash : - -1. Pressez la touche avec le keycode `RESET`, ou reliez les ports GND et RST. Vous n'avez que 7 secondes pour flasher une fois que l'opération a été faite. -2. Attendez que l'OS détecte l'appareil. -3. Flasher le fichier .hex. -4. Attendez que l'appareil redémarre automatiquement. - -ou, utilisez: - - make <keyboard>:<keymap>:avrdude - -#### Commandes Caterina - -Il existe un certain nombre de commandes DFU que vous pouvez utiliser pour mettre à jour le firmware sur un périphérique DFU: - -* `: avrdude` - Il s’agit de l’option normale. Le script va attendre qu’un appareil Caterina soit disponible. Dès que c’est le cas, il flash le firmware. Il attendra de détecter un nouveau port COM pour le flasher. -* `: avrdude-loop` - Cela fonctionne de la même manière que`: avrdude`, mais une fois que chaque périphérique est flashé, il tentera de flasher à nouveau. Cela peut être utile pour flasher plusieurs claviers à la suite. _Cela implique de sortir manuellement de la boucle en appuyant sur Ctrl + C, Cmd + C ou un raccourci équivalent selon votre OS_ -* `: avrdude-split-left` - Cela fonctionne de la même manière que la fonction (`: avrdude`). Toutefois, cela permet aussi de flasher le coté gauche de l'EEPROM des claviers splittés / divisés. C'est donc la méthode recommandée pour les claviers splittés avec Pro Micro. -* `: avrdude-split-right` - Cela fonctionne de la même manière que la fonction (`: avrdude`). Toutefois, cela permet aussi de flasher le coté droite de l'EEPROM des claviers splittés / divisés. C'est donc la méthode recommandée pour les claviers splittés avec Pro Micro. - -## Halfkay - -Halfkay est un protocole ultra-simple développé par PJRC qui utilise HID et qui est fourni avec tous les Teensys après le modèle 2.0. - -Pour vérifier la compatibilité avec le booloader Halfkay, vérifiez que ce bloc est présent dans votre fichier `rules.mk`: - -```make -# Bootloader selection -# Teensy halfkay -# Pro Micro caterina -# Atmel DFU atmel-dfu -# LUFA DFU lufa-dfu -# QMK DFU qmk-dfu -# ATmega32A bootloadHID -# ATmega328P USBasp -BOOTLOADER = halfkay -``` - -Flasher compatibles: - -* [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases) (Interface graphique recomandée) -* [Teensy Loader](https://www.pjrc.com/teensy/loader.html) (petit utilitaire ultra simple) - [Teensy Loader en ligne de commande](https://www.pjrc.com/teensy/loader_cli.html) (Outil en ligne de commande recommandé) - -Séquence de flash: - -1. Pressez la touche du keycode `RESET`, ou reliez les ports RST et GND rapidement. Vous avez ensuite 7 secondes pour réaliser le flash. -2. Attendez que l'OS détecte l'appareil. -3. Flasher le fichier .hex. -4. Redémarrez l'appareil en mode «application». Cela peut être fait automatiquement. - -## USBasploader - -USBasploader est un bootloader développé par matrixstorm. Il est utilisé sur des processeurs AVR non-USB comme le ATmega328P, qui fonctionne grâce à V-USB. - -Pour vérifier la compatibilité avec le booloader USBasploader, vérifiez que ce bloc est présent dans votre fichier `rules.mk`: - -```make -# Bootloader selection -# Teensy halfkay -# Pro Micro caterina -# Atmel DFU atmel-dfu -# LUFA DFU lufa-dfu -# QMK DFU qmk-dfu -# ATmega32A bootloadHID -# ATmega328P USBasp -BOOTLOADER = USBasp -``` - -Flashers compatibles: - -* [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases) (Interface graphique recommandé) -* [avrdude](https://www.nongnu.org/avrdude/) avec le programmeur `usbasp`. -* [AVRDUDESS](https://github.com/zkemble/AVRDUDESS) - -Séquence de flash: - -1. Pressez la touche du keycode `RESET`, ou reliez le port de boot pendant que RST et GND snt reliés. Cela doit être fait très rapidement. -2. Attendez que l'OS détecte l'appareil. -3. Flasher le fichier .hex. -4. Redémarrez l'appareil en mode «application». Cela peut être fait automatiquement. - -## BootloadHID - -BootloadHID est un bootloader pour les microcontrôleurs AVR. L'utilitaire de téleversement ne demande pas de drivers au niveau du kernel et peut être lancé sans installer aucune DLLs. - -Pour vérifier la compatibilité avec le bootloader bootloadHID, vérifiez que ce bloc existe dans votre fichier `rules.mk` : - -```make -# Bootloader selection -# Teensy halfkay -# Pro Micro caterina -# Atmel DFU atmel-dfu -# LUFA DFU lufa-dfu -# QMK DFU qmk-dfu -# ATmega32A bootloadHID -# ATmega328P USBasp -BOOTLOADER = bootloadHID -``` - -Utilitaires de flash compatibles: - -* [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash) (Utilitaire avec interface graphique recommandé) -* [bootloadhid Command Line](https://www.obdev.at/products/vusb/bootloadhid.html) / `:BootloadHID` avec QMK (utilitaire en ligne de commande recommandé) - -Séquence de flash - -1. Entrez dans le bootloader en utilisant l'une de ces méthodes: - * Pressez la touche du keycode `RESET` (Cela ne fonctionnera pas sur certains appareils). - * Verrouillez la touche «Salt» tout en branchant le clavier (Généralement ce principe est documenté dans le fichier readme du clavier) -2. Attendez que l'OS détecte l'appareil. -3. Flasher le fichier .hex. -4. Redémarrez l'appareil en mode «application». Cela peut être fait automatiquement. - -Ou alors: - - make <keyboard>:<keymap>:bootloadHID - -## STM32 - -Tous les processeurs STM32 contiennent un bootloader installé en usine qui ne peut pas être modifié ou supprimé. Certains processeurs STM32 ont des bootloaders qui ne peuvent pas être programmés par USB (ex: STM32F103) mais le processus reste le même. - -Pour le moment, aucune variable `BOOTLOADER` n'est nécessaire dans le fichier `rules.mk`. - -Flashers compatibles: - -* [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases) (interface graphique recommandé) -* [dfu-util](https://github.com/Stefan-Schmidt/dfu-util) / `:dfu-util` (utilitaire en ligne de commande recommandé) - -Séquence pour flasher: - -1. Entrez dans le bootloader en utilisant l'une de ces méthodes: - * Utilisez une touche sur laquelle le keycode `RESET` (Cela peut ne pas fonctionner sur les appareils STM32F042) - * Si un circuit de réinitialisation (Reset) est présent alors utilisé le bouton qui lui est dédié. - * Autrement, vous devez réaliser une liaison entre BOOT0 et VCC (en appuyant sur le bouton ou à l'aide d'un pont) puis faire un pont entre RESET et GND et enfin relacher le pont BOOT0. -2. Attendre que l'os détecte l'appareil. -3. Flasher un fichier `.bin`.h - * Vous allez recevoir un avertissement à propos de la signature DFU. Ignorez-la. -4. Réinitialisez l'appareil en mode «application». Cela peut être fait automatiquement. - * Si vous êtes en train de travailler en ligne de commande, par exemple avec un `make planck/rev6:default:dfu-util` alors soyez bien sur que l'argument `:leave` est passé aux arguments DFU grâce à la variable `DFU_ARGS` à l'intérieur de votre fichier `rules.mk` (Ex: `DFU_ARGS = -d 0483:df11 -a 0 -s 0x08000000:leave`) afin que votre appareil redémarre après avoir été flashé. - -### Commandes STM32 - -Il y a différentes commandes que vous pouvez utiliser pour flasher un firmware dans un appareil STM32: - -* `:dfu-util` - C'est l'option standard pour flasher un appareil STM32. Le script attendra qu'un bootloader STM32 soit présent. -* `:dfu-util-split-left` - Permet de flasher un firmware normalement, tout comme l'option précédente mais permet de configurer le côté gauche des paramètres EEPROM sur un clavier scindé. -* `:dfu-util-split-right` - Permet de flasher un firmware normalement, tout comme l'option précédente mais permet de configurer le côté droit des paramètres EEPROM sur un clavier scindé. -* `:st-link-cli` - Cela permet de flasher le firmware avec l'utilitaire en ligne de commande ST-LINK's plutôt que d'utiliser dfu-util. diff --git a/docs/fr-fr/getting_started_getting_help.md b/docs/fr-fr/getting_started_getting_help.md deleted file mode 100644 index fedb18c76c..0000000000 --- a/docs/fr-fr/getting_started_getting_help.md +++ /dev/null @@ -1,15 +0,0 @@ -# Trouver de l'aide - -Il y a beaucoup de ressources pour trouver de l'aide avec QMK. - -## Chat temps-réel - -Vous trouverez des développeurs QMK et des utilisateurs sur notre [Serveur Discord](https://discord.gg/Uq7gcHh) principal. Il y a des canaux spécifiques dans le serveur pour discuter des firmwares, toolbox, hardware et configurateurs. - -## Sous-Reddit OLKB - -Le forum officiel de QMK est [/r/olkb](https://reddit.com/r/olkb) sur [reddit.com](https://reddit.com). - -## Tickets GitHub - -Vous pouvez ouvrir un [ticket sur GitHub](https://github.com/qmk/qmk_firmware/issues). Ceci est spécialement pratique lorsque votre problème demande une discussion sur le long terme ou un débugage. diff --git a/docs/fr-fr/getting_started_github.md b/docs/fr-fr/getting_started_github.md deleted file mode 100644 index 522b09a03e..0000000000 --- a/docs/fr-fr/getting_started_github.md +++ /dev/null @@ -1,66 +0,0 @@ -# Comment utiliser GitHub avec QMK - -GitHub peut être un peu compliqué pour ceux qui n'y sont pas familier. Ce guide va vous expliquer chaque étape de "fork", clone et envoi d'un pull request avec QMK. - -?> Ce guide part du principe que vous êtes suffisamment à l'aise pour envoyer commandes sur la ligne de commande et que vous avez Git installé sur votre système. - -Commencez par la [page GitHub de QMK](https://github.com/qmk/qmk_firmware), et vous verrez un bouton dans le coin en haut à droite qui indique "Fork": - - - -Si vous faites partie d'une organisation, vous aurez besoin de savoir quel compte utiliser pour le fork. Dans la plupart des cas, vous voudrez créer le fork dans votre compte personnel. Une fois le fork complet (cela peut quelques fois prendre un peu de temps), appuyez sur le bouton "Clone or download": - - - -Faites attention à sélectionner "HTTPS", et sélectionnez le lien et copiez-le: - - - -Ensuite, entrez `git clone --recurse-submodules ` dans la ligne de commande, et collez votre lien: - -``` -user@computer:~$ git clone --recurse-submodules https://github.com/whoeveryouare/qmk_firmware.git -Cloning into 'qmk_firmware'... -remote: Enumerating objects: 9, done. -remote: Counting objects: 100% (9/9), done. -remote: Compressing objects: 100% (5/5), done. -remote: Total 183883 (delta 5), reused 4 (delta 4), pack-reused 183874 -Receiving objects: 100% (183883/183883), 132.90 MiB | 9.57 MiB/s, done. -Resolving deltas: 100% (119972/119972), done. -... -Submodule path 'lib/chibios': checked out '587968d6cbc2b0e1c7147540872f2a67e59ca18b' -Submodule path 'lib/chibios-contrib': checked out 'ede48346eee4b8d6847c19bc01420bee76a5e486' -Submodule path 'lib/googletest': checked out 'ec44c6c1675c25b9827aacd08c02433cccde7780' -Submodule path 'lib/lufa': checked out 'ce10f7642b0459e409839b23cc91498945119b4d' -``` - -Vous avez maintenant votre fork QMK sur votre machine locale, vous pouvez ajouter votre keymap, la compiler et la flasher sur votre board. Une fois heureux avec vos changements, vous pouvez les ajouter, commit, et pousser vers votre fork comme suit: - -``` -user@computer:~$ git add . -user@computer:~$ git commit -m "adding my keymap" -[master cccb1608] adding my keymap - 1 file changed, 1 insertion(+) - create mode 100644 keyboards/planck/keymaps/mine/keymap.c -user@computer:~$ git push -Counting objects: 1, done. -Delta compression using up to 4 threads. -Compressing objects: 100% (1/1), done. -Writing objects: 100% (1/1), 1.64 KiB | 0 bytes/s, done. -Total 1 (delta 1), reused 0 (delta 0) -remote: Resolving deltas: 100% (1/1), completed with 1 local objects. -To https://github.com/whoeveryouare/qmk_firmware.git - + 20043e64...7da94ac5 master -> master -``` - -Vos changements existent maintenant dans votre fork sur GitHub. Si vous allez à cette adresse (`https://github.com/<whoeveryouare>/qmk_firmware`), vous pouvez créer un nouveau "Pull Request" en cliquant sur ce bouton: - - - -Maintenant, vous pourrez voir exactement ce que vous avez commité. Si ça vous semble bien, vous pouvez le finaliser en cliquant sur "Create Pull Request": - - - -Une fois transmis, nous pourrons vous parler de vos changements, vous demander de faire des changements, et éventuellement de les accepter! - -Merci de contribuer à QMK :) diff --git a/docs/fr-fr/getting_started_introduction.md b/docs/fr-fr/getting_started_introduction.md deleted file mode 100644 index b2711a1671..0000000000 --- a/docs/fr-fr/getting_started_introduction.md +++ /dev/null @@ -1,62 +0,0 @@ -# Introduction - -Le but de cette page est d'expliquer les informations de base qui vous serons nécessaire pour travailler sur le projet QMK. Il a pour pré-requis que vous soyez familier à la navigation à l'aide d'un shell Unix, mais ne s'attend pas à ce que vous soyez familier avec C ou la compilation en utilisant make. - -## Structure de base de QMK - -QMK est un fork du projet [tmk_keyboard](https://github.com/tmk/tmk_keyboard) créé par [Jun Wako](https://github.com/tmk). Le code originel de TMK, avec quelques modifications, se trouve dans le dossier `tmk_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`. - -### Structure du Userspace - -Dans le dossier `users` se trouve un répertoire pour chaque utilisateur. C'est un endroit où les utilisateurs peuvent mettre du code qui serait partagé entre plusieurs claviers. Merci de lire la documentation [Fonctionnalité Userspace](feature_userspace.md) pour plus d'information. - -### Structure du projet clavier - -Dans le dossier `keyboards`, son sous-dossier `handwired` et ses sous-dossiers pour les revendeurs et fabriquants (par exemple `clueboard`) se trouve un répertoire pour chaque projet clavier. Par exemple `qmk_firmware/keyboards/clueboard/2x1800`. - -A l'intérieur, vous trouverez la structure suivante: - -* `keymaps/`: différentes keymaps qui peuvent être compilées -* `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. -* `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. -* `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. -* `readme.md`: une brève description du clavier. -* `<keyboardName>.h`: Ce fichier définit le layout du fichier par rapport à la matrice de commutation. -* `<keyboardName>.c`: Ce fichier définit du code custom pour le clavier. - -Pour plus d'information sur la structure du projet, voyez [Directives clavier QMK](hardware_keyboard_guidelines.md). - -### Structure d'une Keymap - -Dans chaque dossier keymap, vous allez trouver les fichiers suivants. Seul le fichier `keymap.c` est nécessaire, et si le reste des fichiers n'existent pas, les options par défaut seront choisies. - -* `config.h`: les options de configuration de votre keymap -* `keymap.c`: tout le code de votre keymap, requis -* `rules.mk`: les features de QMK qui sont activées -* `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. - -# Le fichier `config.h` - -Le fichier `config.h` peut être mis à 3 endroits: - -* keyboard (`/keyboards/<keyboard>/config.h`) -* userspace (`/users/<user>/config.h`) -* keymap (`/keyboards/<keyboard>/keymaps/<keymap>/config.h`) - -Le système de compilation cherche automatiquement les fichiers de configuration dans l'ordre au-dessus. Si vous souhaitez surcharger une configuration définie par un `config.h` précédent, vous devrez d'abord ajouter le code suivant. - -``` -#pragma once -``` - -Ensuite, pour surcharger l'option du fichier `config.h` précédent, vous devez `#undef` puis `#define` l'option à nouveau. - -Voici à quoi l'ensemble du code ressemble une fois regroupé: - -``` -#pragma once - -// overrides go here! -#undef MY_SETTING -#define MY_SETTING 4 -``` diff --git a/docs/fr-fr/newbs.md b/docs/fr-fr/newbs.md deleted file mode 100644 index 6d848b11f8..0000000000 --- a/docs/fr-fr/newbs.md +++ /dev/null @@ -1,23 +0,0 @@ -# Le Guide pour débutant complet à QMK - -QMK 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. - -Vous 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. - -## Vue d'ensemble - -Il y a 7 sections principales dans ce guide: - -* [Pour débuter](fr-FR/newbs_getting_started.md) -* [Compiler votre premier firmware en utilisant la ligne de commande](fr-FR/newbs_building_firmware.md) -* [Compiler votre premier firmware en utilisant l'interface graphique en ligne](fr-FR/newbs_building_firmware_configurator.md) -* [Flasher le Firmware](fr-FR/newbs_flashing.md) -* [Test et Débuggage](fr-FR/newbs_testing_debugging.md) -* [Bonnes pratiques Git](fr-FR/newbs_best_practices.md) -* [Ressources d'apprentissage](fr-FR/newbs_learn_more_resources.md) - -Ce 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). - -## Ressources additionnelles - -* [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 ec68a5e3e5..0000000000 --- a/docs/fr-fr/newbs_best_practices.md +++ /dev/null @@ -1,161 +0,0 @@ -# Bonnes Pratiques - -## Ou, "Comment j'ai appris à ne plus m'en faire et aimer Git." - -Ce 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. - -Ce document suppose les choses suivantes: - -1. 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. -2. Vous avez [configuré votre environnement de compilation](fr-FR/newbs_getting_started.md?id=environment-setup). - -## La branche master de votre fork: Mettre à jour souvent, ne jamais commit - -Il 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. - -Pour réduire les chances de conflits de fusion (merge) — des cas où deux ou plus d'utilisateurs ont édité la même section d'un fichier en parallèle — gardez votre branche `master` relativement à jour et démarrez chaque nouveau développement en créant une nouvelle branche. - -### Mettre à jour votre branche master - -Pour 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: - -```bash -git remote add upstream https://github.com/qmk/qmk_firmware.git -``` - -Pour vérifier que le dépôt a bien été ajouté, lancez la commande `git remote -v`, qui devrait retourner le résultat suivant: - -```bash -$ git remote -v -origin https://github.com/<your_username>/qmk_firmware.git (fetch) -origin https://github.com/<your_username>/qmk_firmware.git (push) -upstream https://github.com/qmk/qmk_firmware.git (fetch) -upstream https://github.com/qmk/qmk_firmware.git (push) -``` - -Maintenant 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 — appelé de manière générale "refs" — 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. - -Pour mettre à jour la branche master de votre "fork", lancez les commandes suivantes (en appuyant sur Enter après chaque ligne): - -```bash -git checkout master -git fetch upstream -git pull upstream master -git push origin master -``` - -Cela 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. - -### Faire des changements - -Pour faire des changements, créez une nouvelle branche en entrant: - -```bash -git checkout -b dev_branch -git push --set-upstream origin dev_branch -``` - -Ceci 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. - -!> Avec `git push`, vous pouvez utiliser `-u` à la place de `--set-upstream` — `-u` est un alias pour `--set-upstream`. - -Vous 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. - -Par 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: - -```bash -git checkout -b dev_branch master -``` - -Maintenant 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: - -```bash -git add path/to/updated_file -git commit -m "My commit message." -``` - -`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. - -!> 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. - -### Publier Vos Changements - -La 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. - -## Résoudre Les Conflits De Merge - -Parfois, 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. - -### Rebaser Vos Changements - -Un *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. - -Pour démarrer, lancez les commandes suivantes: - -```bash -git fetch upstream -git rev-list --left-right --count HEAD...upstream/master -``` - -La 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: - -```bash -$ git rev-list --left-right --count HEAD...upstream/master -7 35 -``` - -Le 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. - -Maintenant que l'état actuel de la branche courante et la branche upstream sont connus, nous pouvons maintenant démarrer une opération de rebase: - -```bash -git rebase upstream/master -``` - -Ceci dit à Git d'annuler les commits de la branche courante puis de les réappliquer sur la branche master de QMK. - -```bash -$ git rebase upstream/master -First, rewinding head to replay your work on top of it... -Applying: Commit #1 -Using index info to reconstruct a base tree... -M conflicting_file_1.txt -Falling back to patching base and 3-way merge... -Auto-merging conflicting_file_1.txt -CONFLICT (content): Merge conflict in conflicting_file_1.txt -error: Failed to merge in the changes. -hint: Use 'git am --show-current-patch' to see the failed patch -Patch failed at 0001 Commit #1 - -Resolve all conflicts manually, mark them as resolved with -"git add/rm <conflicted_files>", then run "git rebase --continue". -You can instead skip this commit: run "git rebase --skip". -To abort and get back to the state before "git rebase", run "git rebase --abort". -``` - -Ceci 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: - -```bash -<<<<<<< HEAD -<p>For help with any issues, email us at support@webhost.us.</p> -======= -<p>Need help? Email support@webhost.us.</p> ->>>>>>> Commit #1 -``` - -La 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. - -Parce 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. - -```bash -<p>Need help? Email support@webhost.us.</p> -``` - -Maintenant, lancez: - -```bash -git add conflicting_file_1.txt -git rebase --continue -``` - -Git 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 81870d31e4..0000000000 --- a/docs/fr-fr/newbs_building_firmware.md +++ /dev/null @@ -1,81 +0,0 @@ -# Compiler Votre Premier Firmware - -Maintenant 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. - -Si 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. - -## Naviguez vers votre répertoire keymaps - -Démarrez par naviguer dans le répertoire `keymaps` de votre clavier. - -?> Si vous êtes sous macOS ou Windows, il y a des commandes que vous pouvez utiliser pour facilement ouvrir le dossier keymaps. - -?> macOS: - - open keyboards/<keyboard_folder>/keymaps - -?> Windows: - - start .\\keyboards\\<keyboard_folder>\\keymaps - -## Créez une copie de la keymap `default` - -Une 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é (_). - -Afin d'automatiser ce processus, vous avez aussi l'option de lancer le script `new_keymap.sh`. - -Naviguez vers le répertoire `qmk_firmware/util` et tapez ce qui suit: - -``` -./new_keymap.sh <keyboard path> <username> -``` - -Par exemple, pour un utilisateur s'appeleant John, essayant de créer une nouvelle keymap pour le 1up60hse, il taperait: - -``` -./new_keymap.sh 1upkeyboards/1up60hse john -``` - -## Ouvrez `keymap.c` dans votre éditeur de texte préféré - -Ouvrez 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: - - const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { - -Cette 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. - -!> 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. - -## Customisez le layout à votre goût - -Libre à 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: - -* [Keycodes](keycodes.md) -* [Fonctionnalités](features.md) -* [FAQ](faq.md) - -?> 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. - -## Compilez votre firmware - -Lorsque 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: - - make <my_keyboard>:<my_keymap> - -Par exemple, si votre keymap s'appelle "xyverz" et vous compilez une keymap pour une plank rev5, vous allez utiliser cette commande: - - make planck/rev5:xyverz - -Durant 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: - -``` -Linking: .build/planck_rev5_xyverz.elf [OK] -Creating load file for flashing: .build/planck_rev5_xyverz.hex [OK] -Copying planck_rev5_xyverz.hex to qmk_firmware folder [OK] -Checking file size of planck_rev5_xyverz.hex [OK] - * File size is fine - 18392/28672 -``` - -## Flasher votre firmware - -Allez 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 d06242f392..0000000000 --- a/docs/fr-fr/newbs_building_firmware_configurator.md +++ /dev/null @@ -1,105 +0,0 @@ -# Configurateur de QMK - -Le [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. - -?> **S'il vous plaît, suivez les étapes suivantes dans l'ordre.** - -Regardez le [Tutoriel vidéo](https://youtu.be/tx54jkRC9ZY)https://www.youtube.com/watch?v=-imgglzDMdY) - -Le configurateur de QMK fonctionne mieux avec Chrome et Firefox. - -!> **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.** - -## Sélectionner votre clavier - -Cliquez la boîte déroulante et sélectionnez le clavier pour lequel vous voulez créer une keymap. - -?> Si votre clavier a plusieurs versions, faites attention à utiliser la bonne. - -Je vais le répéter, parce que c'est important - -!> **FAITES ATTENTION A UTILISER LA BONNE VERSION !** - -Si 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. - -## Sélectionner la disposition de votre clavier - -Choisissez 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. - -## Nom de la Keymap - -Appelez cette keymap comme vous voulez. - -?> 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. - -## Créer votre keymap - -Entrer un keycode peut s'accomplir de 3 façons différentes. - -1. Glisser déposer -2. Cliquer sur un endroit vide sur le layout et cliquer sur le keycode souhaité -3. Cliquer sur un endroit vide sur le layout et appuyer sur une touche physique de votre clavier. - -Passez 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: - -[Référence Keycode basique](https://docs.qmk.fm/#/keycodes_basic) -[Référence Keycode avancé](https://docs.qmk.fm/#/feature_advanced_keycodes) - -Dans 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. - -### Exemples - -3 places pour la barre d'espace: Remplissez les TOUTES avec la barre d'espace - -2 places pour un retour clavier: Remplissez les DEUX avec un retour clavier - -2 places pour un shift droit: Remplissez les DEUX avec un shift droit - -1 place pour un shift gauche et 1 place pour le support ISO: Remplissez les deux avec un shift gauche - -5 places, mais seulement 4 touches: Deviner et vérifier, ou demander à quelqu'un qui l'a déjà fait. - -## Sauvez votre keymap pour des éditions futures - -Une 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. - -Vous pouvez ensuite charger ce fichier .json à nouveau en appuxant sur le bouton `Import Keymap`. - -!> **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**. - -## Générer votre fichier firmware - -Appuyez sur le bouton `Compile`. - -Une fois la compilation terminée, vous pourrez appuyer sur le bouton vert `Download Firmware`. - -## Ecrire votre firmware sur votre clavier - -Merci de vous référer à [Flasher le Firmware](fr-FR/newbs_flashing.md) - -## Dépannage - -#### Mon fichier json ne fonctionne pas - -Si 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) - -Sinon... vous avez raté mon message écris en gras qui dit de ne pas utiliser d'autres fichiers .json? - -#### Il y a des espaces en trop dans mon alyout? Qu'est-ce que je fais? - -Si 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. - -#### C'est quoi le keycode pour ....... - -Merci de regarder - -[Référence keycode basique](https://docs.qmk.fm/#/keycodes_basic) -[Référence keycode avancé](https://docs.qmk.fm/#/feature_advanced_keycodes) - -#### Ca ne compile pas? - -Merci de vérifier les autres dispositions de votre keymap afin d'être sûr qu'il n'y a pas de touches aléatoires. - -## Problèmes et Bugs - -Nous 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 f1f6b1131f..0000000000 --- a/docs/fr-fr/newbs_flashing.md +++ /dev/null @@ -1,367 +0,0 @@ -# Flasher votre clavier - -Maintenant que vous avez compilé un firmware custom, vous allez vouloir le flasher dans votre clavier. - -## Flasher votre clavier avec QMK Toolbox - -La manière la plus simple de flasher votre clavier est avec [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases). - -Toutefois, 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). - -### Charger le fichier dans QMK Toolbox - -Dé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`. - -?> 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. - -?> Windows: - - start . - -?> macOS: - - open . - -Le fichier firmware suit toujours ce format de nommage: - - <keyboard_name>_<keymap_name>.{bin,hex} - -Par exemple, le `plank/rev5` avec une keymap `default` aura ce nom de fichier: - - planck_rev5_default.hex - -Une 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é. - -### Mettez votre clavier en mode DFU (Bootloader) - -Afin 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. - -Chaque 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: - -* Enfoncez les deux touches shift et appuyez sur `Pause` -* Enfoncez les deux touches shift et appuyez sur `B` -* 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. -* Appuyez la touche physique `RESET` en bas du PCB -* Trouvez les pins sur le PCB marquées `BOOT0` ou `RESET`, court circuitez ces pins en branchant votre PCB - -Lorsque vous aurez réussi, vous verrez le message suivant dans QMK Toolbox: - -``` -*** Clueboard - Clueboard 66% HotSwap disconnected -- 0xC1ED:0x2390 -*** DFU device connected -``` - -### Flasher votre clavier - -Appuyez sur le boutton `Flash` dans QMK Toolbox. Vous verrez un résultat similaire à ce qui suit: - -``` -*** Clueboard - Clueboard 66% HotSwap disconnected -- 0xC1ED:0x2390 -*** DFU device connected -*** Attempting to flash, please don't remove device ->>> dfu-programmer atmega32u4 erase --force - Erasing flash... Success - Checking memory from 0x0 to 0x6FFF... Empty. ->>> dfu-programmer atmega32u4 flash /Users/skully/qmk_firmware/clueboard_66_hotswap_gen1_skully.hex - Checking memory from 0x0 to 0x55FF... Empty. - 0% 100% Programming 0x5600 bytes... - [>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>] Success - 0% 100% Reading 0x7000 bytes... - [>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>] Success - Validating... Success - 0x5600 bytes written into 0x7000 bytes memory (76.79%). ->>> dfu-programmer atmega32u4 reset - -*** DFU device disconnected -*** Clueboard - Clueboard 66% HotSwap connected -- 0xC1ED:0x2390 -``` - -## Flashez votre clavier à l'aide de la ligne de commande - -C'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 : - - make <my_keyboard>:<my_keymap>:flash - -Par 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: - - make planck/rev5:xyverz:flash - -La 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. - -Cependant, 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: - - WARNING: This board's bootloader is not specified or is not supported by the ":flash" target at this time. - -Dans ce cas, vous devrez choisir le bootloader. - -Il 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. - -Vous pouvez trouver plus d'information à propos des bootloaders sur la page [Instructions de flash et information sur le Bootloader](flashing.md). - -Si 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. - -### DFU - -Pour 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: - - make <my_keyboard>:<my_keymap>:dfu - -Par exemple, si vous keymap s'appelle "xyverz" et vous compilez une keymap pour une plank rev5, vous utiliserez cette commande: - - make planck/rev5:xyverz:dfu - -Une fois la compilation terminée, le résultat devrait être le suivant: - -``` -Linking: .build/planck_rev5_xyverz.elf [OK] -Creating load file for flashing: .build/planck_rev5_xyverz.hex [OK] -Copying planck_rev5_xyverz.hex to qmk_firmware folder [OK] -Checking file size of planck_rev5_xyverz.hex - * File size is fine - 18574/28672 - ``` - -Une 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. - - dfu-programmer: no device present. - Error: Bootloader not found. Trying again in 5s. - -Une fois terminé, vous devrez mettre à zéro le contrôleur. Vous allez voir un résultat similaire à ceci: - -``` -*** Attempting to flash, please don't remove device ->>> dfu-programmer atmega32u4 erase --force - Erasing flash... Success - Checking memory from 0x0 to 0x6FFF... Empty. ->>> dfu-programmer atmega32u4 flash /Users/skully/qmk_firmware/clueboard_66_hotswap_gen1_skully.hex - Checking memory from 0x0 to 0x55FF... Empty. - 0% 100% Programming 0x5600 bytes... - [>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>] Success - 0% 100% Reading 0x7000 bytes... - [>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>] Success - Validating... Success - 0x5600 bytes written into 0x7000 bytes memory (76.79%). ->>> dfu-programmer atmega32u4 reset -``` - -?> 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). - -#### Commandes DFU - -Il y aun certain nombre de commandes du DFU que vous pouvez utiliser pour flasher un firmware sur un device DFU: - -* `: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. -* `:dfu-ee` - Ceci flash un fichier `eep` à la place du standard hex, peu commun. -* `: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._ -* `: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._ - -### Caterina - -Pour 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: - - make <my_keyboard>:<my_keymap>:avrdude - -Par exemple, si votre keymap se nomme "xyverz" et que vous compilez une keymap pour un Lets Split rev2, vous utiliserez la commande suivante: - - make lets_split/rev2:xyverz:avrdude - -Une fois le firmware compilé, vous aurez le résultat suivant: - -``` -Linking: .build/lets_split_rev2_xyverz.elf [OK] -Creating load file for flashing: .build/lets_split_rev2_xyverz.hex [OK] -Checking file size of lets_split_rev2_xyverz.hex [OK] - * File size is fine - 27938/28672 -Detecting USB port, reset your controller now.............. -``` - -Une 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: - -``` -Detected controller on USB port at /dev/ttyS15 - -Connecting to programmer: . -Found programmer: Id = "CATERIN"; type = S - Software Version = 1.0; No Hardware Version given. -Programmer supports auto addr increment. -Programmer supports buffered memory access with buffersize=128 bytes. - -Programmer supports the following devices: - Device code: 0x44 - -avrdude.exe: AVR device initialized and ready to accept instructions - -Reading | ################################################## | 100% 0.00s - -avrdude.exe: Device signature = 0x1e9587 (probably m32u4) -avrdude.exe: NOTE: "flash" memory has been specified, an erase cycle will be performed - To disable this feature, specify the -D option. -avrdude.exe: erasing chip -avrdude.exe: reading input file "./.build/lets_split_rev2_xyverz.hex" -avrdude.exe: input file ./.build/lets_split_rev2_xyverz.hex auto detected as Intel Hex -avrdude.exe: writing flash (27938 bytes): - -Writing | ################################################## | 100% 2.40s - -avrdude.exe: 27938 bytes of flash written -avrdude.exe: verifying flash memory against ./.build/lets_split_rev2_xyverz.hex: -avrdude.exe: load data flash data from input file ./.build/lets_split_rev2_xyverz.hex: -avrdude.exe: input file ./.build/lets_split_rev2_xyverz.hex auto detected as Intel Hex -avrdude.exe: input file ./.build/lets_split_rev2_xyverz.hex contains 27938 bytes -avrdude.exe: reading on-chip flash data: - -Reading | ################################################## | 100% 0.43s - -avrdude.exe: verifying ... -avrdude.exe: 27938 bytes of flash verified - -avrdude.exe: safemode: Fuses OK (E:CB, H:D8, L:FF) - -avrdude.exe done. Thank you. -``` - -Si vous avez un souci, essayez de faire ceci: - - sudo make <my_keyboard>:<my_keymap>:avrdude - -#### Commandes Caterina - -Il existe un certain nombre de commandes DFU que vous pouvez utiliser pour mettre à jour le firmware sur un périphérique DFU: - -* `: avrdude` - Il s’agit de l’option normale. 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. -* `: avrdude-loop` - Cela fonctionne de la même manière que `: avrdude`, mais une fois que chaque périphérique est flashé, il tentera de flasher à nouveau. Cela peut être utile pour flasher plusieurs claviers à la suite. _Cela implique de sortir manuellement de la boucle en appuyant sur Ctrl + C, Cmd + C ou un raccourci équivalent selon votre OS_ -* `: avrdude-split-left` - Cela fonctionne de la même manière que la fonction (`: avrdude`). Toutefois, cela permet aussi de flasher le coté gauche de l'EEPROM des claviers splittés / divisés. C'est donc la méthode recommandée pour les claviers splittés avec Pro Micro. -* `: avrdude-split-right` - Cela fonctionne de la même manière que la fonction (`: avrdude`). Toutefois, cela permet aussi de flasher le coté droite de l'EEPROM des claviers splittés / divisés. C'est donc la méthode recommandée pour les claviers splittés avec Pro Micro. - -### HalfKay - -Pour 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: - - make <my_keyboard>:<my_keymap>:teensy - -Par exemple, si vous keymap s'appelle "xyverz" et vous compilez une keymap pour un Ergodox ou un Ergodox EZ, vous utiliserez cette commande: - - make ergodox_ez:xyverz:teensy - -Une fois la compilation du firmware terminée, votre sortie devrait ressembler à ça: - -``` -Linking: .build/ergodox_ez_xyverz.elf [OK] -Creating load file for flashing: .build/ergodox_ez_xyverz.hex [OK] -Checking file size of ergodox_ez_xyverz.hex [OK] - * File size is fine - 25584/32256 - Teensy Loader, Command Line, Version 2.1 -Read "./.build/ergodox_ez_xyverz.hex": 25584 bytes, 79.3% usage -Waiting for Teensy device... - (hint: press the reset button) - ``` - -Une fois terminé, réinitialisez votre board. Une fois fait, vous verrez une sortie comme ça: - - ``` - Found HalfKay Bootloader -Read "./.build/ergodox_ez_xyverz.hex": 28532 bytes, 88.5% usage -Programming............................................................................................................................................................................ -................................................... -Booting -``` - -### STM32 (ARM) - -Pour 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: - - make <my_keyboard>:<my_keymap>:dfu-util - -Par 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): - - make planck/rev6:xyverz:dfu-util - -Une fois le firmware compilé, il va afficher quelque chose comme ça: - -``` -Linking: .build/planck_rev6_xyverz.elf [OK] -Creating binary load file for flashing: .build/planck_rev6_xyverz.bin [OK] -Creating load file for flashing: .build/planck_rev6_xyverz.hex [OK] - -Size after: - text data bss dec hex filename - 0 41820 0 41820 a35c .build/planck_rev6_xyverz.hex - -Copying planck_rev6_xyverz.bin to qmk_firmware folder [OK] -dfu-util 0.9 - -Copyright 2005-2009 Weston Schmidt, Harald Welte and OpenMoko Inc. -Copyright 2010-2016 Tormod Volden and Stefan Schmidt -This program is Free Software and has ABSOLUTELY NO WARRANTY -Please report bugs to http://sourceforge.net/p/dfu-util/tickets/ - -Invalid DFU suffix signature -A valid DFU suffix will be required in a future dfu-util release!!! -Opening DFU capable USB device... -ID 0483:df11 -Run-time device DFU version 011a -Claiming USB DFU Interface... -Setting Alternate Setting #0 ... -Determining device status: state = dfuERROR, status = 10 -dfuERROR, clearing status -Determining device status: state = dfuIDLE, status = 0 -dfuIDLE, continuing -DFU mode device DFU version 011a -Device returned transfer size 2048 -DfuSe interface name: "Internal Flash " -Downloading to address = 0x08000000, size = 41824 -Download [=========================] 100% 41824 bytes -Download done. -File downloaded successfully -Transitioning to dfuMANIFEST state -``` - -#### Commandes STM32 - -Il y aun certain nombre de commandes du DFU que vous pouvez utiliser pour flasher un firmware sur un device STM32: - -* `: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. -* `: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. -* `: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. -* `: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. - -### BootloadHID - -Pour 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: - - make <my_keyboard>:<my_keymap>:bootloaderHID - -Par exemple, si votre keymap s'appelle "xyverz" et que vous compilez une keymap pour un jj40, utilisez cette commande: - - make jj40:xyverz:bootloaderHID - -Une fois le firmware compilé, vous aurez cette sortie: - -``` -Linking: .build/jj40_default.elf [OK] -Creating load file for flashing: .build/jj40_default.hex [OK] -Copying jj40_default.hex to qmk_firmware folder [OK] -Checking file size of jj40_default.hex [OK] - * The firmware size is fine - 21920/28672 (6752 bytes free) -``` - -A 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``` - -``` -Error opening HIDBoot device: The specified device was not found -Trying again in 5s. -``` - -Une fois ce résultat obtenu, réinitialisez le contrôleur. Le résultat suivant devrait s’afficher: - -``` -Page size = 128 (0x80) -Device size = 32768 (0x8000); 30720 bytes remaining -Uploading 22016 (0x5600) bytes starting at 0 (0x0) -0x05580 ... 0x05600 -``` - -## Faites l'essai! - -Bravo! Votre firmware customisé a été programmé sur votre clavier! - -Essayez-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 1a5740185c..0000000000 --- a/docs/fr-fr/newbs_getting_started.md +++ /dev/null @@ -1,101 +0,0 @@ -# Introduction - -Votre 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. - -QMK 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. - -# Guide de démarrage - -Avant 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. - -Si 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). - -## Logiciels à télécharger - -### Editeur de texte - -Vous 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_. - -Vous 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. - -?> 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. - -### QMK Toolbox - -QMK 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. - -[Télécharger la dernière version ici.](https://github.com/qmk/qmk_toolbox/releases/latest) - -* Pour Windows: `qmk_toolbox.exe` (portable) or `qmk_toolbox_install.exe` (installeur) -* Pour macOS: `QMK.Toolbox.app.zip` (portable) or `QMK.Toolbox.pkg` (installeur) - -## Configurez votre environnement - -Nous 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. - -?> 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> -[Commandes Linux à savoir](https://www.guru99.com/must-know-linux-commands.html)<br> -[Commandes Unix de base](https://www.tjhsst.edu/~dhyatt/superap/unixcmd.html) - -### Windows - -Vous devez installer MSYS2 et Git. - -* Suivez les instructions d'installation sur la [page de MSYS2](https://www.msys2.org). -* Fermez tous les terminaux MSYS2 éventuellement ouverts et ouvrez un nouveau terminal MSYS2 MinGW 64-bit. -* Installez Git en lançant la commande: `pacman -S git`. - -### macOS - -Vous devez installer Homebew. Suivez les instructions sur la [page de Homebrew](https://brew.sh). - -Une fois Homebrew installé, continuez avec _Configurer QMK_. Dans cette étape, nous lancerons un script qui va installer d'autres paquets. - -### Linux - -Vous devez installer Git. Il est très probable que vous l'ayez déjà installé, mais sinon, une des commandes suivantes devrait l'installer: - -* Debian / Ubuntu / Devuan: `apt-get install git` -* Fedora / Red Hat / CentOS: `yum install git` -* Arch: `pacman -S git` - -?> Docker est aussi une option sur toutes les plateformes. [Appuyez ici pour plus de détail.](getting_started_build_tools.md#docker) - -## Configurer QMK - -Une 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: - -```shell -git clone --recurse-submodules https://github.com/qmk/qmk_firmware.git -cd qmk_firmware -``` - -?> 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. - -QMK 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: - - util/qmk_install.sh - -## Testez votre environnement de compilation - -Maintenant 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: - - make <keyboard>:default - -Par exemple, pour compiler un firmware pour une Clueboard 66%, vous utiliserez: - - make clueboard/66/rev3:default - -Une fois ceci fait, vous devriez avoir beaucoup d'information dans votre sortie qui devrait se terminer par quelque chose de similaire à ça: - -``` -Linking: .build/clueboard_66_rev3_default.elf [OK] -Creating load file for flashing: .build/clueboard_66_rev3_default.hex [OK] -Copying clueboard_66_rev3_default.hex to qmk_firmware folder [OK] -Checking file size of clueboard_66_rev3_default.hex [OK] - * The firmware size is fine - 26356/28672 (2316 bytes free) -``` - -# Créer votre Keymap - -Vous ê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 01b1c9e8eb..0000000000 --- a/docs/fr-fr/newbs_learn_more_resources.md +++ /dev/null @@ -1,14 +0,0 @@ -# Ressources d'apprentissage - -Ces ressources permettent de donner aux nouveaux membres de la communauté QMK plus de compréhension aux informations données dans la documentation Newbs. - -Ressources Git: - -* [Tutoriel général](https://www.codecademy.com/learn/learn-git) -* [Jeu Git pour apprendre avec des exemples](https://learngitbranching.js.org/) -* [Des ressources Git pour en savoir plus à propos de GitHub](getting_started_github.md) -* [Des ressources Git spécifiques à QMK](contributing.md) - -Ressources sur les lignes de commande: - -* [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 85a7fb9f13..0000000000 --- a/docs/fr-fr/newbs_testing_debugging.md +++ /dev/null @@ -1,104 +0,0 @@ -# Test et débugage - -Une 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. - -## Tester - -Tester 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. - -Note: ces programmes ne sont ni fournis ni approuvés par QMK. - -* [QMK Configurator](https://config.qmk.fm/#/test/) (Web) -* [Switch Hitter](https://web.archive.org/web/20190413233743/https://elitekeyboards.com/switchhitter.php) (Windows seulement) -* [Keyboard Viewer](https://www.imore.com/how-use-keyboard-viewer-your-mac) (Mac seulement) -* [Keyboard Tester](https://www.keyboardtester.com) (Web) -* [Keyboard Checker](https://keyboardchecker.com) (Web) - -## Débuguer - -Votre 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. - -```c -void keyboard_post_init_user(void) { - // Customise these values to desired behaviour - debug_enable=true; - debug_matrix=true; - //debug_keyboard=true; - //debug_mouse=true; -} -``` - -### Débuguer avec QMK Toolbox - -Pour les plateformes compatibles, [QMK Toolbox](https://github.com/qmk/qmk_toolbox) peut être utilisé pour afficher les messages de débugage pour votre clavier. - -### Débuguer avec hid_listen - -Vous 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. - -<!-- FIXME: Describe the debugging messages here. --> - -## Envoyer vos propres messages de débugage - -Parfois, 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: - -```c -#include "print.h" -``` - -Une fois fait, vous pouvez utiliser les fonctions print suivantes: - -* `print("string")`: Affiche une simple chaîne de caractères. -* `uprintf("%s string", var)`: Affiche une chaîne de caractères formatée. -* `dprint("string")` Affiche une chaîne de caractère simple, mais uniquement lorsque le mode debug est activé. -* `dprintf("%s string", var)`: Affiche une chaîne de caractère formatée, mais uniquement lorsque le mode debug est activé. - -## Exemples de debugage - -Si 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). - -### A quelle position de la matrice se trouve cette activation de touche? - -Lors 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`. - -```c -bool process_record_user(uint16_t keycode, keyrecord_t *record) { - // If console is enabled, it will print the matrix position and status of each key pressed -#ifdef CONSOLE_ENABLE - uprintf("KL: kc: %u, col: %u, row: %u, pressed: %u\n", keycode, record->event.key.col, record->event.key.row, record->event.pressed); -#endif - return true; -} -``` - -Exemple de sortie - -```text -Waiting for device:....... -Listening: -KL: kc: 169, col: 0, row: 0, pressed: 1 -KL: kc: 169, col: 0, row: 0, pressed: 0 -KL: kc: 174, col: 1, row: 0, pressed: 1 -KL: kc: 174, col: 1, row: 0, pressed: 0 -KL: kc: 172, col: 2, row: 0, pressed: 1 -KL: kc: 172, col: 2, row: 0, pressed: 0 -``` - -### Combien de temps cela a pris pour une activation de touche? - -Lorsque 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. - -```c -#define DEBUG_MATRIX_SCAN_RATE -``` - -Exemple de sortie - -```text - > matrix scan frequency: 315 - > matrix scan frequency: 313 - > matrix scan frequency: 316 - > matrix scan frequency: 316 - > matrix scan frequency: 316 - > matrix scan frequency: 316 -``` diff --git a/docs/he-il/README.md b/docs/he-il/README.md deleted file mode 100644 index 5c113eb498..0000000000 --- a/docs/he-il/README.md +++ /dev/null @@ -1,33 +0,0 @@ -<div dir="rtl" markdown="1"> -# קושחה עבור Quantum Mechanical Keyboard - -[](https://github.com/qmk/qmk_firmware/tags) -[](https://discord.gg/Uq7gcHh) -[](https://docs.qmk.fm) -[](https://github.com/qmk/qmk_firmware/pulse/monthly) -[](https://github.com/qmk/qmk_firmware/) - -## מה היא קושחת QMK? - -QMK (*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 המקוסטמות שלך. - -## איך להשיג אותה - -אם אתם מתכננים לתרום מיפוי מקשים, מקלדת או יכולת ל QMK, הדבר הקל ביותר הוא [לעשות פורק לריפו בGitHub](https://github.com/qmk/qmk_firmware#fork-destination-box), ולעשות קלון לריפו בסביבה המקומית ושם לבצע את השינויים שלכם, לדחוף אותם ולפתוח [Pull Request](https://github.com/qmk/qmk_firmware/pulls) מהפורק שלך. - -אחרת, אפשר להוריד את הקושחה באופן ישיר ([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`). - -## איך לקמפל - -לפני שתצליחו לקמפל, תדרשו [להתקין סביבה](he-il/getting_started_build_tools.md) עבור פיתוח AVR ו/או ARM. ברגע שהדבר בוצע, תוכלו להריץ פקודת `make` כדי לבנות מקלדת ומיפוי עם התחביר הבא: - - make planck/rev4:default - -כך תוכלו לבנות את גרסא `rev4` של ה `planck` עם מיפוי ברירת המחדל (`default`). לא כל המקלדות בעלות גרסאות (נקרא גם תת-פרוייקט או תיקייה), במקרה כזה, אפשר להריץ את הפקודה הבאה: - - make preonic:default - -## איך להתאים - -לQMK יש המון [יכולות](he-il/features.md) שאפשר לנווט בהן, וכמות נכבדת של [תיעוד ודוקומנטציה](https://docs.qmk.fm) בה אפשר לנבור. רוב הפיצ׳רים באים לידי ביטוי על ידי שינוי [מיפוי המקלדת](he-il/keymap.md) ושינוי [קודי המקשים](he-il/keycodes.md). -</div> diff --git a/docs/he-il/_summary.md b/docs/he-il/_summary.md deleted file mode 100644 index 148eb6400d..0000000000 --- a/docs/he-il/_summary.md +++ /dev/null @@ -1,140 +0,0 @@ -<div dir="rtl" markdown="1"> - -**בשפה העברית** -* [המדריך המלא למתחילים](he-il/newbs.md) - * [מקורות ללמידה](he-il/newbs_learn_more_resources.md) -* [בסיס QMK](he-il/README.md) - * [מבוא לQMK](he-il/getting_started_introduction.md) - * [איך להשתמש בGitHub](he-il/getting_started_github.md) - * [קבלת עזרה](he-il/getting_started_getting_help.md) -* [שאלות נפוצות](he-il/faq.md) - * [שאלות נפוצות כלליות](he-il/faq_general.md) -* [חומרה](he-il/hardware.md) -* התייחסויות - * [איך לתעד נכון](he-il/documentation_best_practices.md) - -**בשפה האנגלית** -* [המדריך המלא למתחילים](he-il/newbs.md) - * [התחלה](he-il/newbs_getting_started.md) - * [בנייה של הקושחה הראשונה שלך](he-il/newbs_building_firmware.md) - * [צריבה של הקושחה](he-il/newbs_flashing.md) - * [בדיקות ודיבאגינג](he-il/newbs_testing_debugging.md) - * [עבודה נכונה ב GIT](he-il/newbs_best_practices.md) - * [מקורות ללמידה](he-il/newbs_learn_more_resources.md) - -* [בסיס QMK](he-il/README.md) - * [מבוא לQMK](he-il/getting_started_introduction.md) - * [QMK CLI](he-il/cli.md) - * [QMK CLI Config](he-il/cli_configuration.md) - * [תרומה ל QMK](he-il/contributing.md) - * [איך להשתמש בGitHub](he-il/getting_started_github.md) - * [קבלת עזרה](he-il/getting_started_getting_help.md) - -* [שינויים משמעותיים](he-il/breaking_changes.md) - * [2019 Aug 30](he-il/ChangeLog/20190830.md) - -* [שאלות נפוצות](he-il/faq.md) - * [שאלות נפוצות כלליות](he-il/faq_general.md) - * [בנייה/קומפילציה של QMK](he-il/faq_build.md) - * [דיבאגינג ופתרון תקלות של QMK](he-il/faq_debug.md) - * [מיפוי מקשים](he-il/faq_keymap.md) - * [התקנת דרייברים עם Zadig](he-il/driver_installation_zadig.md) - -* מדריכים מפורטים - * [התקנת כלי Build](he-il/getting_started_build_tools.md) - * [מדריך Vagrant](he-il/getting_started_vagrant.md) - * [הוראות בנייה/קומפילציה](he-il/getting_started_make_guide.md) - * [צריבת קושחה](he-il/flashing.md) - * [התאמה אישית של הפונקציונאליות](he-il/custom_quantum_functions.md) - * [מיפוי מקשים](he-il/keymap.md) - -* [חומרה](he-il/hardware.md) - * [מעבדי AVR](he-il/hardware_avr.md) - * [דרייברים](he-il/hardware_drivers.md) - -* התייחסויות - * [מדריך למקלדות](he-il/hardware_keyboard_guidelines.md) - * [אפשרויות הגדרות](he-il/config_options.md) - * [קודי מקשים](he-il/keycodes.md) - * [קונבנציות קוד - C](he-il/coding_conventions_c.md) - * [קונבנציות קוד - Python](he-il/coding_conventions_python.md) - * [איך לתעד נכון](he-il/documentation_best_practices.md) - * [טמפלטים לדוקומנטציה](he-il/documentation_templates.md) - * [מילון](he-il/reference_glossary.md) - * [בדיקות יחידה](he-il/unit_testing.md) - * [פונקציות שימושיות](he-il/ref_functions.md) - * [תמיכה בConfigurator](he-il/reference_configurator_support.md) - * [פורמט info.json](he-il/reference_info_json.md) - * [פיתוח בPython CLI](he-il/cli_development.md) - -* [תכונות](he-il/features.md) - * [Basic Keycodes](he-il/keycodes_basic.md) - * [US ANSI Shifted Keys](he-il/keycodes_us_ansi_shifted.md) - * [Quantum Keycodes](he-il/quantum_keycodes.md) - * [Advanced Keycodes](he-il/feature_advanced_keycodes.md) - * [Audio](he-il/feature_audio.md) - * [Auto Shift](he-il/feature_auto_shift.md) - * [Backlight](he-il/feature_backlight.md) - * [Bluetooth](he-il/feature_bluetooth.md) - * [Bootmagic](he-il/feature_bootmagic.md) - * [Combos](he-il/feature_combo.md) - * [Command](he-il/feature_command.md) - * [Debounce API](he-il/feature_debounce_type.md) - * [DIP Switch](he-il/feature_dip_switch.md) - * [Dynamic Macros](he-il/feature_dynamic_macros.md) - * [Encoders](he-il/feature_encoders.md) - * [Grave Escape](he-il/feature_grave_esc.md) - * [Haptic Feedback](he-il/feature_haptic_feedback.md) - * [HD44780 LCD Controller](he-il/feature_hd44780.md) - * [Key Lock](he-il/feature_key_lock.md) - * [Layouts](he-il/feature_layouts.md) - * [Leader Key](he-il/feature_leader_key.md) - * [LED Matrix](he-il/feature_led_matrix.md) - * [Macros](he-il/feature_macros.md) - * [Mouse Keys](he-il/feature_mouse_keys.md) - * [OLED Driver](he-il/feature_oled_driver.md) - * [One Shot Keys](he-il/one_shot_keys.md) - * [Pointing Device](he-il/feature_pointing_device.md) - * [PS/2 Mouse](he-il/feature_ps2_mouse.md) - * [RGB Lighting](he-il/feature_rgblight.md) - * [RGB Matrix](he-il/feature_rgb_matrix.md) - * [Space Cadet](he-il/feature_space_cadet.md) - * [Split Keyboard](he-il/feature_split_keyboard.md) - * [Stenography](he-il/feature_stenography.md) - * [Swap Hands](he-il/feature_swap_hands.md) - * [Tap Dance](he-il/feature_tap_dance.md) - * [Terminal](he-il/feature_terminal.md) - * [Thermal Printer](he-il/feature_thermal_printer.md) - * [Unicode](he-il/feature_unicode.md) - * [Userspace](he-il/feature_userspace.md) - * [Velocikey](he-il/feature_velocikey.md) - -* למייקרים ומודרים - * [מדריך לכתיבה ידנית](he-il/hand_wire.md) - * [מדריך לצריבת ISP](he-il/isp_flashing_guide.md) - * [מדריך לדיבאגינג ARM](he-il/arm_debugging.md) - * [מנהל התקן I2C](he-il/i2c_driver.md) - * [מנהל התקן SPI](he-il/spi_driver.md) - * [בקרת GPIO](he-il/internals_gpio_control.md) - * [המרת Proton C](he-il/proton_c_conversion.md) - -* להבנה עמוקה יותר - * [איך עובדות מקלדות](he-il/how_keyboards_work.md) - * [להבין את QMK](he-il/understanding_qmk.md) - -* נושאים נוספים - * [שימוש ב - Eclipse עם QMK](he-il/other_eclipse.md) - * [שימוש ב - VSCode עם QMK](he-il/other_vscode.md) - * [תמיכה](he-il/getting_started_getting_help.md) - * [כיצד להוסיף תרגום](he-il/translating.md) - -* QMK מבפנים (בתהליך) - * [Defines](he-il/internals_defines.md) - * [Input Callback Reg](he-il/internals_input_callback_reg.md) - * [Midi Device](he-il/internals_midi_device.md) - * [Midi Device Setup Process](he-il/internals_midi_device_setup_process.md) - * [Midi Util](he-il/internals_midi_util.md) - * [Send Functions](he-il/internals_send_functions.md) - * [Sysex Tools](he-il/internals_sysex_tools.md) - -</div> diff --git a/docs/he-il/documentation_best_practices.md b/docs/he-il/documentation_best_practices.md deleted file mode 100644 index bba9d886ab..0000000000 --- a/docs/he-il/documentation_best_practices.md +++ /dev/null @@ -1,67 +0,0 @@ -<div dir="rtl" markdown="1"> -# איך לתעד נכון - -עמוד זה קיים כדי לתעד את השיטות הטובות ביותר כאשר כותבים תיעוד עבור QMK. מעקב אחר הוראות אלה יעזור לשמור על סגנון וטון עקביים, אשר בתורם יעזרו לאנשים אחרים להבין טוב יותר את QMK. - -# פתיחת עמוד - -התיעוד שלך צריך בד״כ להפתח עם כותרת בגודל H1, אחריה פסקה אחת של תיאור של מה המשתמש ימצא בעמוד זה. -זכור כי כותרת זו והפסקה ימוקמו ליד תוכן העניינים, אז חשוב לשמור על כותרת קצרה ולהמנע ממשפטים ארוכים ללא פיסוק. - -לדוגמה: - -``` -# הכותרת שלי - -עמוד זה מדבר על היכולת הסופר-מגניבה שלי. אתה יכול להשתמש ביכולת זו כדי להכין קפה, לסחוט תפוזים ולקבל משלוח של ביצים ועוגות מהסופר הקרוב באמצעות רחפן. -``` - -# כותרות - -עמוד התיעוד צריך לאופן כללי לכלול מס׳ כותרות בגודל "H1". רק כותרות מגודל H1 ו- H2 יכללו בתוכן העניינים, אז חשוב לתכנן אותם בהתאם. הכותרות לא להיות רחבות מידי כדי למנוע מתוכן העניינים להפוך להיות רחב מידי - -# בלוקי רמיזה מעוצבים - -ניתן להוסיף בלוקי רמיזה מעוצבים שמצויירים מסביב לטקסט כדי למשוך תשומת לב אליו. - -### חשוב - -``` -!> זה חשוב -``` - -יתרנדר כ: - -!> זה חשוב - -### טיפים כלליים - -``` -?> זהו טיפ שימושי. -``` - -יתרנדר כ: - -?> זהו טיפ שימושי. - - -# תיעוד יכולות ופיצ׳ריםDocumenting Features - -אם יוצרים יכולת חדשה ב QMK, צרו עמוד תיעוד עבורה. העמוד לא צריך להיות ארוך במיוחד, מספר משפטים המתארים את היכולת (פיצ׳ר) וטבלה המתארת קודי מקשים רלוונטיים זה מספיק. הנה דוגמה בסיסית: - -```markdown -# הפיצ׳ר המגניב שלי - -עמוד זה מדבר על היכולת הסופר-מגניבה שלי. אתה יכול להשתמש ביכולת זו כדי להכין קפה, לסחוט תפוזים ולקבל משלוח של ביצים ועוגות מהסופר הקרוב באמצעות רחפן. - -## קודי המקשים המגניבים של היכולת שלי - -|Long Name|Short Name|Description| -|---------|----------|-----------| -|KC_COFFEE||Make Coffee| -|KC_CREAM||Order Cream| -|KC_SUGAR||Order Sugar| -``` - -מקמו את התיעוד שלכם בתוך `docs/feature_<my_cool_feature>.md`, והוסיפו קישור לקובץ זה במקום המתאים ב `docs/_sidebar.md`. אם הוספתם קודי מקשים נוספים, תקפידו להוסיף אותם ל- `docs/keycodes.md` עם לינק לעמוד היכולת שלכם. -</div> diff --git a/docs/he-il/faq.md b/docs/he-il/faq.md deleted file mode 100644 index 0a783eb8ca..0000000000 --- a/docs/he-il/faq.md +++ /dev/null @@ -1,8 +0,0 @@ -<div dir="rtl" markdown="1"> -# שאלות נפוצות - -* [כללי](faq_general.md) -* [בנייה או קומפילציה של QMK](faq_build.md) -* [דיבאגינג ופתרון בעיות של QMK](faq_debug.md) -* [מיפוי מקשים](faq_keymap.md) -</div> diff --git a/docs/he-il/faq_general.md b/docs/he-il/faq_general.md deleted file mode 100644 index fc102d6c6a..0000000000 --- a/docs/he-il/faq_general.md +++ /dev/null @@ -1,17 +0,0 @@ -<div dir="rtl" markdown="1"> -# שאלות נפוצות - -## מה זה QMK? - -[QMK](https://github.com/qmk), קיצור עבור Quantum Mechanical Keyboard, הוא קבוצה של אנשים הבונים כלים עבור מקלדות מותאמות אישית. התחלנו עם [קושחת QMK](https://github.com/qmk/qmk_firmware), פורק של [TMK](https://github.com/tmk/tmk_keyboard) אשר שונה באופן ניכר. - -## מה ההבדלים העיקריים בין QMK ו-Keymap TMK? - -TMK עוצב ומומש במקור ע״י [Jun Wako](https://github.com/tmk). QMK התחיל כפורק של [Jack Humbert](https://github.com/jackhumbert) של הפרוייקט של TMK עבור Planck. אחרי כמה זמן הפורק של ג׳ק השתנה מזה של TMK וב- 2015 ג׳ק החליט לשנות את שמו של הפורק ל- QMK. - -מנק׳ מבט טכנית, QMK נבנה על גבי TMK ע״י הוספת יכולות ופיצ׳רים חדשים. ראוי לציון ש- QMK הרחיב את מס׳ קודי המקלדת האפשריים ומשתמש בהם למימוש יכולות מתקדמות כמו `S()`, `LCTL()`, ו- `MO()`. ניתן לראות רשימה מלאה של קודי המקלדת האלה ב - [קודי מקלדת](keycodes.md). - -מנק׳ מבט של הפרוייקט וניהול הקהילה, TMK מנהל את כל המקלדות הנתמכות בעצמו, עם מעט תמיכה מהקהילה. כל אחד יכול לעשות פורק מהפרוייקט עבור מקלדות אחרות. רק מס׳ מיפויי מקשים נמצאים בברירת המחדל כך שאנשים בד״כ לא משתפים מיפויי מקשים זה עם זה. QMK מעודד את השיתוף של המקלדות וקודי המקשים דרך רפוזיטורי בניהול מרכזי, אשר מקבל את כל בקשות ה- Pull Requests שעומדות בסטנדרט האיכות. רובם מנוהלות ע״י הקהילה, אבל הצוות של QMK עוזר כשנדרש. - -לשתי הגישות יש יתרונות וחסרונות וקוד עובר בחופשיות בין TMK ל- QMK כשצריך. -</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 7dec3e87d6..0000000000 --- a/docs/he-il/getting_started_getting_help.md +++ /dev/null @@ -1,17 +0,0 @@ -<div dir="rtl" markdown="1"> -# קבלת עזרה - -ישנם משאבים רבים לצורך קבלת עזרה עם QMK. - -## צ׳אט בזמן אמת - -אפשר למצוא מפתחי QMK ומשתמשים [בשרת ה-Discord הראשי שלנו](https://discord.gg/Uq7gcHh). ישנם ערוצים ספציפיים בשרת לצורך שיחות על הקושחה, ארגז הכלים, חומרה והמגדיר. - -## סאב-רדיט OLKB - -הפורום הרשמי של QMK נמצא ב - [/r/olkb](https://reddit.com/r/olkb) באתר [reddit.com](https://reddit.com). - -## סוגיות GitHub - -ניתן לפתוח [סוגייה ב-GitHub](https://github.com/qmk/qmk_firmware/issues). הדבר שימושי במיוחד כאשר הסוגיה דורשת דיון עמוק וארוך או דיבאגינג. -</div> diff --git a/docs/he-il/getting_started_github.md b/docs/he-il/getting_started_github.md deleted file mode 100644 index ca79e40f9a..0000000000 --- a/docs/he-il/getting_started_github.md +++ /dev/null @@ -1,74 +0,0 @@ -<div dir="rtl" markdown="1"> -# איך להשתמש ב-GitHub עם QMK - -GitHub עלול להיות קצת טריקי למי שלא מכיר את העבודה איתו - מדריך זה ילווה אתכם שלב אחר שלב דרך ביצוע פעולות fork, clone ו-pull request עם QMK. - -?> מדריך זה מניח שאתם מרגישים בנוח עם הרצה של פקודות בסביבת command line (שורת הפקודה) ו-git מותקן במערכת שלכם. - -התחילו ב- [עמוד של QMK ב-GitHub](https://github.com/qmk/qmk_firmware), ותצמאו כפתור בחלק העליון מימין עם התיכוב "Fork": - - - -אם אתם חלק מארגון, תצטרכו לבחור לאיזה חשבון לבצע פעולת fork. ברוב המבקרים, תרצו לבצע fork לתוך החשבון הפרטי שלכם. ברגע שה-fork הסתיים (לפעמים זה יכול לקחת קצת זמן) הקליקו על כפתור ה-"Clone or Download": - - - -תוודאו שאתם בוחרים באופצייה של "HTTPS", בחרו את הקישור והעתיקו אותו: - - - -מכאן והלאה, הקיש `git clone --recurse-submodules ` בשורת הפקודה והדביקו את הלינק שלכם: - -<div dir="ltr" markdown="1"> - -``` -user@computer:~$ git clone --recurse-submodules https://github.com/whoeveryouare/qmk_firmware.git -Cloning into 'qmk_firmware'... -remote: Enumerating objects: 9, done. -remote: Counting objects: 100% (9/9), done. -remote: Compressing objects: 100% (5/5), done. -remote: Total 183883 (delta 5), reused 4 (delta 4), pack-reused 183874 -Receiving objects: 100% (183883/183883), 132.90 MiB | 9.57 MiB/s, done. -Resolving deltas: 100% (119972/119972), done. -... -Submodule path 'lib/chibios': checked out '587968d6cbc2b0e1c7147540872f2a67e59ca18b' -Submodule path 'lib/chibios-contrib': checked out 'ede48346eee4b8d6847c19bc01420bee76a5e486' -Submodule path 'lib/googletest': checked out 'ec44c6c1675c25b9827aacd08c02433cccde7780' -Submodule path 'lib/lufa': checked out 'ce10f7642b0459e409839b23cc91498945119b4d' -``` - -</div> - -כעת, יש לכם את ה-fork של QMK על המכונה המקומית שלכם ואתם יכולים להוסיף את מיפויי המקשים שלכם, לקמפל את הפרוייקט ולצרוב אותו על הלוח שלכם. כשאתם שלמים עם השינוי שעשיתם, תוכלו להוסיף, לבצע פעולת commit ולדחוף את השינויים ל-fork שלכם באופן הבא: - -<div dir="ltr" markdown="1"> - -``` -user@computer:~$ git add . -user@computer:~$ git commit -m "adding my keymap" -[master cccb1608] adding my keymap - 1 file changed, 1 insertion(+) - create mode 100644 keyboards/planck/keymaps/mine/keymap.c -user@computer:~$ git push -Counting objects: 1, done. -Delta compression using up to 4 threads. -Compressing objects: 100% (1/1), done. -Writing objects: 100% (1/1), 1.64 KiB | 0 bytes/s, done. -Total 1 (delta 1), reused 0 (delta 0) -remote: Resolving deltas: 100% (1/1), completed with 1 local objects. -To https://github.com/whoeveryouare/qmk_firmware.git - + 20043e64...7da94ac5 master -> master -``` - -</div> - -השינויים שלכם יופיעו ב-fork שלכם ב-GitHub - אם תחזרו לשם (`https://github.com/<whoeveryouare>/qmk_firmware`), תוכלו ליצור "Pull Request חדש" ע״י הקשה על הכפתור הבא: - - - -כאן תוכלו לראות בדיוק למה עשיתם commit - אם הכל נראה תקין, תוכלו להשלים את הפעולה ע״י הקשה על "Create Pull Request": - - - -אחרי שהגשתם, אנו עלולים לפנות אליכם לגבי השינויים שהצעתם, נבקש שתבצעו שינויים ובסופו של דבר נקבל את השינויים! תודה שתרמתם לפרוייקט QMK :) -</div> diff --git a/docs/he-il/getting_started_introduction.md b/docs/he-il/getting_started_introduction.md deleted file mode 100644 index fca86bdaaf..0000000000 --- a/docs/he-il/getting_started_introduction.md +++ /dev/null @@ -1,72 +0,0 @@ -<div dir="rtl" markdown="1"> -# מבוא - -עמוד זה מנסה להסביר את המידע הבסיסי אותו תדרשו לדעת כדי לעבוד עם פרוייקט QMK. הוא מניח שאתם יודעים איך לנווט בסביבת Unix Shell, אבל לא מניח שאתם מכירים את שפת C או קומפילציה באמצעות make. - -## מבנה QMK בסיסי - -QMK הוא פורק של הפרוייקט [tmk_keyboard](https://github.com/tmk/tmk_keyboard) של [Jun Wako](https://github.com/tmk). קוד הTMK המקורי, עם התאמות, יכול להמצא בתיקיית `tmk_core`. התוספות של QMK לפרוייקט יכולות להמצא בתיקיית `quantum`. פרוייקטי מקלדות יכולות להמצא בתיקיות `handwired` ו- `keyboard`. - -### מבנה אחסון המשתמש - -בתוך תיקיית `users` יש תיקייה לכל משתמש. זה המקום למשתמשים להוסיף קוד שהם רוצים להשתמש בו במקלדות שונות. מומלץ לעיין במסמך [תכונות אחסון המשתמש](feature_userspace.md) לקבלת מידע נוסף. - -### מבנה פרוייקט המקלדת - -בתוך תיקיית `keyboards`, תת התיקייה `handwired` ותת התיקיות של היצרן והמוכר, לדוגמה `clueboard` היא תיקייה לכל פרוייקט מקלדת - `qmk_firmware/keyboards/clueboard/2x1800` בתוך התיקייה הזאת תמצאו את המבנה הבא: - - -* `keymaps/`: מיפויי מקשים שונים היכולים להבנות -* `rules.mk`: קובץ המגדיר את הגדרות ברירת המחדל של `make`. נא לא לערוך את הקובץ ישירות, במקום זאת, השתמשו בקובץ מיפוי המקשים ספציפי `rules.mk`. -* `config.h`: הקובץ מכיל הגדרות לזמן הקומפילציה. נא לא לערוך את הקובץ ישירות אלא להשתמש בקובץ `config.h` לכל מיפויי מקשים. -* `info.json`: הקובץ מכיל הגדרות פריסה עבור QMK Configurator. צפו ב [תמיכת Configurator](reference_configurator_support.md) למידע נוסף. -* `readme.md`: סקירה כללית של המקלדת. -* `<keyboardName>.h`: הקובץ בו פריסת המקלדת מוגדרת אל מול מטריצת המתגים של המקלדת. -* `<keyboardName>.c`: הקובץ בו ניתן למצוא קוד מותאם למקלדת. - -למידע נוסף - אנא הכנסו ל [QMK](hardware_keyboard_guidelines.md). -For more information on project structure, see [QMK מדריך למקלדת](hardware_keyboard_guidelines.md). - -### מבנה מפיוי המקשים - -בכל ספריית מיפוי מקשים, הקבצים הבאים עלולים להמצא. רק הקובץ `keymap.c` הוא חובה, אם השאר לא נמצאים, אפשרויות ברירת המחדל יבחרו. -In 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. - -* `config.h`: ההגדרות השונות עבור מיפוי המקשים. -* `keymap.c`: כל הקודים של מיפוי המקשים, קובץ חובה -* `rules.mk`: אילו יכולות של QMK מאופשרות. -* `readme.md`: הסבר על מיפוי המקשים, איך אחרים ישתמשו בו והסבר על היכולות. נא להעלות תמונות לשירותים כמו imgur. - -# קובץ `config.h` - -לקובץ `config.h` יש 3 מיקומים אפשריים: - -* keyboard (`/keyboards/<keyboard>/config.h`) -* userspace (`/users/<user>/config.h`) -* keymap (`/keyboards/<keyboard>/keymaps/<keymap>/config.h`) - -מערכת הבילד אוטומטית בוחרת את קובץ ההגדרות לפי הסדר הנ״ל. אם רוצים לדרוס הגדרה מסויימת שהוגדרה בקובץ `config.h` קודם, ראשית תצטרכו להשתמש בקוד מוכן עבור ההגדרות שאתם רוצים לשנות. - -<div dir="ltr" markdown="1"> - -``` -#pragma once -``` - -</div> - -כדי לדרוס הגדרות מקובץ `config.h` קודם, אתם מוכרחים להשתמש בפקודת `#undef` ואז שוב `#define`. - -דוגמה לקוד כזה נראית כך: -<div dir="ltr" markdown="1"> - -``` -#pragma once - -// overrides go here! -#undef MY_SETTING -#define MY_SETTING 4 -``` - -</div> -</div> diff --git a/docs/he-il/hardware.md b/docs/he-il/hardware.md deleted file mode 100644 index fca03bd64b..0000000000 --- a/docs/he-il/hardware.md +++ /dev/null @@ -1,10 +0,0 @@ -<div dir="rtl" markdown="1"> -# חומרה - -QMK רצה על מגוון של חומרות. אם המעבד שלך יכול להיות ממוקד (מטורגט) ע״י [LUFA](https://www.fourwalledcubicle.com/LUFA.php) או [ChibiOS](https://www.chibios.org) כנראה שתוכל לגרום ל QMK לרוץ על המעבד. קטע זה מדבר על הרצת QMK, ותקשורת עם, סוגים שונים של חומרות. - -* [מדריך למקלדת](hardware_keyboard_guidelines.md) -* [מעבדי AVR](hardware_avr.md) -* מעבדי ARM (TBD) -* [מנהלי התקנים](hardware_drivers.md) -</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 4127c387ff..0000000000 --- a/docs/he-il/newbs_learn_more_resources.md +++ /dev/null @@ -1,16 +0,0 @@ -<div dir="rtl" markdown="1"> -# מקורות ללמידה - -המקורות הבאים מטרתם היא לתת למשתמשים חדשים בקהילת QMK כדי להבין לעומק את המידע שמגיע במסמכי המתחילים. - -מקורות גיט: - -* [מדריך כללי מעולה](https://www.codecademy.com/learn/learn-git) -* [משחק גיט כדי ללמוד מדוגמאות](https://learngitbranching.js.org/) -* [מקורות גיט כדי ללמוד עוד על GitHub](getting_started_github.md) -* [מקור גיט כדי ללמוד במפורש על QMK](contributing.md) - -מקורות לפקודות שורה (Command Line): - -* [מדריך טוב על Command Line](https://www.codecademy.com/learn/learn-the-command-line) -</div> diff --git a/docs/he-il/proton_c_conversion.md b/docs/he-il/proton_c_conversion.md deleted file mode 100644 index 9642ca3090..0000000000 --- a/docs/he-il/proton_c_conversion.md +++ /dev/null @@ -1,36 +0,0 @@ -<div dir="rtl" markdown="1"> -# המרה של לוח להשתמש ב-Proton C - -אם לוח נתמך ב-QMK משתמש בלוח Pro Micro (או כל לוח נתמך) ואתם רוצים להשתמש ב-Proton C, ניתן לייצר את החומרה ע"י הוספה של הפקודה `CONVERT_TO_PROTON_C=yes` (או `CTPC=yes`) לפקודת make, כמו כאן: -<div dir="ltr" markdown="1"> - -``` - make 40percentclub/mf68:default CTPC=yes -``` - -</div> -ניתן להוסיף את אותו ארגומנט לקובץ `rules.mk` במיפוי המקשים שלכם, שתיצור את אותה התוצאה. - -הדבר חושף את דגל `CONVERT_TO_PROTON_C` שניתן להשתמש בו בקוד שלכם באמצעות פקודת `#ifdef`, כמו כאן: -<div dir="ltr" markdown="1"> - -``` - #ifdef CONVERT_TO_PROTON_C - // Proton C code - #else - // Pro Micro code - #endif -``` - -</div> -לפני שתצליחו לקמפל, יכול להיות שתקבלו שגיאות שונות לגבי `PORTB/DDRB`, וכו' שלא הוגדרו, אם כך, תצטרכו להמיר את קודי המקלדת להשתמש ב - [בקרי GPIO](internals_gpio_control.md) שיעבדו עבור ARM וגם AVR. הדבר לא אמור להשפיע על הבילדים של AVR בכלל. - -ל-Proton C יש רק מנורת LED אחת על הלוח (C13), וכברירת מחדל, TXLED (D5) ממופה אליו. אם תרצו במקום, למפות אליו את RXLED (B0), הוסיפו את השורה הבא לקובץ `config.h`: -<div dir="ltr" markdown="1"> - -``` - #define CONVERT_TO_PROTON_C_RXLED -``` - -</div> -</div> diff --git a/docs/he-il/quantum_keycodes.md b/docs/he-il/quantum_keycodes.md deleted file mode 100644 index 5374fd47ad..0000000000 --- a/docs/he-il/quantum_keycodes.md +++ /dev/null @@ -1,25 +0,0 @@ -<div dir="rtl" markdown="1"> -# קודי מקלדת Quantum - -קודי מקלדת Quantum מאפשרים התאמה נוחה יותר של מיפוי המקשים שלך מעבר למה שהבסיסי מאפשר, ללא צורך בהגדרת של פעולות מותאמות אישית. - -כל קודי המקלדת בתוך quantum הם מספרים בין `0x0000` ֿֿֿ ל-`0xFFFF`. בתוך הקובץ `keymap.c` זה עלול להראות כאילו יש לך פונקציות ומקרים יחודיים נוספים, אבל בסופו של דבר הקדם-מעבד של שפת C יתרגם אלה לתוך מספר יחיד בין 4 בתים. QMK שמרה את מרחב הכתובות בין `0x0000` עד ל- `0x00FF` עבור קודי מקשים סטנדרטיים. קודי מקשים אלה, כגון `KC_A`, `KC_1`, ו- `KC_LCTL`, אשר מתארים מקשים בסיסיים מוגדרים בתוך USB HID specification. - -בעמודו זה יש לנו את קודי המקשים מתועדים בין `0x00FF` ֿֿ ל- `0xFFFF` אשר משומשים בשביל לממש יכולות מתקדמות של quantum. אם תגדירו קודי מקשים משלכם, הם יתווספו לתוך המרחב הזה גם כן. - -## קודי מקשים של QMK -<div dir="ltr" markdown="1"> - -``` -|Key |Aliases |Description | -|---------------|-----------|---------------------------------------------------------------------| -|`RESET` | |Put the keyboard into DFU mode for flashing | -|`DEBUG` | |Toggle debug mode | -|`EEPROM_RESET` |`EEP_RST` |Resets EEPROM state by reinitializing it | -|`KC_GESC` |`GRAVE_ESC`|Escape when tapped, <code>`</code> when pressed with Shift or GUI| -|`KC_LEAD` | |The [Leader key](feature_leader_key.md) | -|`KC_LOCK` | |The [Lock key](feature_key_lock.md) | -``` - -</div> -</div> diff --git a/docs/index.html b/docs/index.html index 5312b9105d..f5a8dbbf12 100644 --- a/docs/index.html +++ b/docs/index.html @@ -51,13 +51,7 @@ basePath: '/', name: 'QMK Firmware', nameLink: { - '/de/': '/#/de/', - '/es/': '/#/es/', - '/fr-fr/': '/#/fr-fr/', - '/he-il/': '/#/he-il/', '/ja/': '/#/ja/', - '/pt-br/': '/#/pt-br/', - '/ru-ru/': '/#/ru-ru/', '/zh-cn/': '/#/zh-cn/', '/': '/#/' }, @@ -68,30 +62,20 @@ auto2top: true, autoHeader: true, fallbackLanguages: [ - 'de', - 'es', - 'fr-fr', - 'he-il', 'ja', - 'pt-br', - 'ru-ru', 'zh-cn' ], formatUpdated: '{YYYY}/{MM}/{DD} {HH}:{mm}', search: { paths: 'auto', placeholder: { - '/es/': 'Buscar', '/zh-cn/': '搜索', '/ja/': '検索', - '/pt-br/': 'Busca', '/': 'Search' }, noData: { - '/es/': '¡Ningún resultado!', '/zh-cn/': '没有结果!', '/ja/': '見つかりません!', - '/pt-br/': 'Nenhum resultado!', '/': 'No results!' }, depth: 6 @@ -103,21 +87,14 @@ copyCode: { buttonText: { '/zh-cn/': '点击复制', - '/ru/' : 'Скопировать в буфер обмена', - '/de-de/': 'Klicken Sie zum Kopieren', - '/es/' : 'Haga clic para copiar', '/' : 'Copy to clipboard' }, errorText: { '/zh-cn/': '错误', - '/ru/' : 'ошибка', '/' : 'Error' }, successText: { '/zh-cn/': '复制', - '/ru/' : 'Скопировано', - '/de-de/': 'Kopiert', - '/es/' : 'Copiado', '/' : 'Copied' } }, diff --git a/docs/ko-kr/README.md b/docs/ko-kr/README.md deleted file mode 100644 index a3b5b91011..0000000000 --- a/docs/ko-kr/README.md +++ /dev/null @@ -1,32 +0,0 @@ -# Quantum Mechanical Keyboard Firmware - -[](https://github.com/qmk/qmk_firmware/tags) -[](https://discord.gg/Uq7gcHh) -[](https://docs.qmk.fm) -[](https://github.com/qmk/qmk_firmware/pulse/monthly) -[](https://github.com/qmk/qmk_firmware/) - -## QMK Firmware 란? - -QMK(*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는 커스텀회로와 핸드와이어드 키보드을 작동시키는데에도 사용가능합니다. - - -## 설치하기 - -만약 당신이 QMK에 키보드, 키맵, 또는 새로운 기능을 추가하고싶다면, 가장쉬운 방법은 Github를 통해 [저장소(REPO)를 추가하고]((https://github.com/qmk/qmk_firmware#fork-destination-box)) 로컬에서 변화 또는 수정하고, [PULL REQUEST](https://github.com/qmk/qmk_firmware/pulls)을 통해 업로드 할수 있습니다. - -또다른 방법으로는, 직접 파일들 로컬로 다운로드 하거나([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`)을 통해 클론을 만들수 있습니다. - -## 컴파일 - -먼저 컴파일을 하기전 AVR 이나 ARM [개발환경](getting_started_build_tools.md)을 구축해야 합니다. 모든준비가 끝났다면 `make`를 다음과 같이 키보드와 키맵을 선택하여 컴파일 할 수 있습니다. - - make planck/rev4:default - -이 커맨드는 `rev4`버전의 `planck`를 `default`키맵으로 컴파일 할것입니다. 다만 모든 키보드는 파일, 수정본 또는 세부프로젝트를 가지고있지 않음으로 수정본 부분을 생략될수 있습니다. - - make preonic:default - -## 커스터마이징 - -QMK는 사용할 수 있는 매우 다양한 [기능](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 c5aa8d0c03..0000000000 --- a/docs/ko-kr/getting_started_build_tools.md +++ /dev/null @@ -1,156 +0,0 @@ -# 컴파일 도구 설치 - -이 페이지는 QMK 컴파일 환경을 설치하는 방법을 설명합니다. 이 페이지는 AVR 프로세서들(예를 들면 atmega32u4와 비슷한)을 위한 가이드를 제공합니다 - -<!-- FIXME: We should have ARM instructions somewhere. --> - - -**노트:** 만약 당신이 처음 시작한다면 [입문자를 위한 가이드](newbs.md)페이지를 확인하세요. - -계속하기전에 당신의 서브모듈(외부라이브러리)이 최신인지 `make git-submodule`을 사용하여 확인하세요. - -## 리눅스 - -당신이 항상 최신 파일을 가지고 있는지는 `sudo util/qmk_install.sh`을 이용하여 간단히 확인할 수 있습니다. 이 명령어는 당신이 필요한 모든 속성물(dependencies)를 설치할 것입니다. **이 명령어는 `apt-get upgrade`를 사용합니다** - -또한 당신의 직접 필요한 것들을 설치할 수도 있습니다. 하지만 이 자료는 항상 최신의 자료을 가지고 있지 않습니다. - -현재로써 필요한 것은 다음과 같습니다. 하지만 당신이 하는 작업에 따라 당신은 다음 패키지를 다 쓰지 않을 수도 있습니다. 또한 환경에 따라 모든 다음 패키지는 다른이름으로 존재하거나, 없을 수도 있습니다. - -``` -build-essential -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 -git -``` - -당신이 사용하는 패키지 매니져에서 이러한 방법으로 설치하십시요. - -데비안 / 우분투 예시: - - sudo apt-get update - 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 - -페도라 / 레드햇 예시: - - 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 - -아치 / 맨자로(Manjaro) 예시: - - 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 - -## 닉스 (NIX) - -만약 당신이 [NixOS](https://nixos.org/)를 사용중이거나 NIX를 리눅스 또는 맥에서 사용중이라면 `nix-shell`를 root 디렉토리에서 사용하여 컴파일 환경의 구축할 수 있습니다. - -기본적으로 다음 커맨드는 AVR과 ARM 컴파일러를 설치할것입니다. 만약 필요 없다면 `avr` 또는 `arm`을 인수에서 해제할 수 있습니다. - - nix-shell --arg arm false - -## 맥 -당신이 홈브루([homebrew](https://brew.sh/))를 사용한다면, 다음을 입력하세요. - - brew tap osx-cross/avr - brew tap PX4/homebrew-px4 - brew update - brew install avr-gcc@7 - brew link --force avr-gcc@7 - brew install dfu-programmer - brew install dfu-util - brew install gcc-arm-none-eabi - brew install avrdude - -이 방법을 가장 추천합니다. 만약 홈브루가 없다면 커맨드라인 환경에서 매우 편한 [Homebrew](https://brew.sh/)를 다운받는 것을 추천합니다. 참고로 `avr-gcc@7`를 설치하는 중 `make`과 `make install`는 대개 20분 넘게 걸리고 CPU 사용량이 높아집니다. - -## msys2를 사용하는 윈도우 (추천) -윈도우 비스타 부터 최신버젼까지 가장추천되는 환경은 [msys2](https://www.msys2.org)를 이용하는 것입니다. (윈도우 7과 윈도우 10에서 모두 테스트되었음) - -* 이 사이트에 있는 설명을 이용해 msys2를 설치하세요: https://www.msys2.org -* ``MSYS2 MingGW 64-bit`` 를 여세요 -* QMK폴더로 이동하세요. c드라이브 루트에 있는경우: - * `$ cd /c/qmk_firmware` -* `util/qmk_install.sh`을 실행시키고 나오는데요 따라하세요 - -### 크리에이터 업데이트 -만약 당신의 윈도우 10이 크리에이터 업데이트 버전 또는 더 높은 버전이라면 바로 컴파일과 프로그램 업로드(flashing)를 할 수 있습니다. 크리에이터 업데이트 전 버전이라면 컴파일만 가능합니다. 만약 당신이 잘 모르겠거나 업데이트된 버전이 아니라면 [이 링크](https://support.microsoft.com/en-us/instantanswers/d4efb316-79f0-1aa1-9ef3-dcada78f3fa0/get-the-windows-10-creators-update)를 확인해 보십시오. - -### 리눅스용 윈도우 하위 시스템 사용 (Windows10 Subsystem for Linux) -크리에이터 업데이트에 추가로 만약 당신이 리눅스용 윈도우 하위 시스템이 필요하다면 이 링크에서 다운받으십시오: [설명](https://www.howtogeek.com/249966/how-to-install-and-use-the-linux-bash-shell-on-windows-10/) - -만약 당신이 이미 리눅스용 윈도우 하위 시스템을 Anniversary업데이트를 통해 받았다면 이 링크에서 16.04LTS로 업데이트 하는것을 추천합니다. 왜냐하면 업데이트 없이는 일부키보드가 14.04LTS에 포함되있는 도구들로 컴파일되지 않을수 있기때문입니다 : [WSL 업데이트](https://betanews.com/2017/04/14/upgrade-windows-subsystem-for-linux/) - - -### Git -만약 당신이 이미 파일을 로컬로 복제하였다면 이 섹션을 무시하십시요. - -당신은 파일을 기본적인 git을 사용하여 로컬로 복제해야 합니다. **주의, WSL Git을 사용하면 안됩니다** [Git](https://git-scm.com/download/win) 이 링크에서 git을 다운받고 설치하십시오. -그리고 [기본설정](https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup), 유저네임과 이메일을 설정하는 것은 만약 당신이 온라인에 기여할 계획이라면 매우 중요합니다. - -Git의 설치가 완료되었다면 Git Bash커맨드을 열고 당신의 복제 QMK파일이 있는 위치로 이동하고 `git clone --recurse-submodules https://github.com/qmk/qmk_firmware`를 실행 시키십니오. 이 커맨드는 새로운 `qmk_firmware`폴더를 이미 존재하는 것의 하위 폴더설정으로 생성할 것입니다. - -### 도구(Toolchain) 설정 -기본적으로 도구설정은 리눅스용 윈도우 하위 시스템이 설치될때 자동으로 설정됩니다. 하지만 수동적으로 하고 싶다면 여기 설명이 있습니다. (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. ) - -1. "Bash On Ubuntu On Windows" 을 실행시키십시오. -2. 당신이 `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`.) -3. `util/wsl_install.sh`를 실행시키고 화면에 나오는 지시를 따르십니오. -4. Bash command window를 재실행 시키십시오. -5. 이로써 당신은 컴파일과 프로그램 업로드(flashing)을 위한 준비가 모두 끝났습니다. - -### 중요한 참고사항 -*`util/wsl_install.sh` 명령어를 다시 실행시켜 최신 업데이트를 다운받을 수 있습니다. -* QMK 폴더의 위치는 윈도우 파일시스템을 기반으로 해야 됩니다. WSL는 외부실행파일를 작동 시킬수 없기 때문이죠. -* WSL의 Git은 윈도우용 Git과 **호환되지 않습니다** -* 파일을 수정하는 것은 WSL안과 밖에서 모두 가능합니다 하지만 만약 .makefile 혹은 .sh를 수정한다면 유닉스 라인엔딩(Unix line endings)을 지원하는 에디터를 사용하는지 확인하십이오. 그렇지 않다면 컴파일이 되지않을 수도 있습니다. - -## 윈두우 (비스타 혹은 더 최신) (비추천) - -이 섹션은 윈도우 비스타 혹은 더 최신버젼을 위한 오래된 설명입니다. [MSYS2](#windows-with-msys2-recommended)를 사용하는 것을 더 추천합니다. - -1. WinAVR을 설치하였다면 먼저 삭제하십시오. -2. [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**) -3. 만약 당신이 Infinity을 기반으로 하는 키보드에 프로그램 업로드를(flashing) 할거라면 dfu-util을 설치해야 합니다, [Input Club](https://github.com/kiibohd/controller/wiki/Loading-DFU-Firmware) 를 참고 하십시오. -4. [MinGW](https://sourceforge.net/projects/mingw/files/Installer/mingw-get-setup.exe/download)를 설치하십시오. 설치중 윈도우화면에서 GUI 추가 설치 옵션을 해재하십니오. **기본 설치 위치를 바꾸지 마십시오.** 이 명령어는 기본위치를 기반으로 하고 있습니다. -5. 레파지토리를 복제하십시오. [이 링크로 압축파일을 받고 앞축해제 하십시오.](https://github.com/qmk/qmk_firmware/archive/master.zip) 윈도우 탐색기에서 다운받은 파일을 여십시오. -6. `\util` 폴더를 여십시오. -7. `1-setup-path-win` .bat파일을 더블클릭해서 실행시키시오. 유저 계정 설정 변경을 허용해야될 수도 있습니다. 스페이스바를 눌러 설치가 성공적으로 완료되었다는 메세지를 닫을 수 있습니다. -8. `2-setup-environment-win` .bat파일에 우클릭해서 '관리자 권한으로 실행'으로 실행시키십시오. 이 작업을 꽤 오래 걸릴 수도 있습니다. 또한 드라이버 설정을 승인해야 될 수도 있습니다. 하지만 이 모든것이 끝나면 당신의 시스템의 설정이 모두 끝났습니다. - -만약 이 작업을 하는데에 문제가 있어 도움받고 싶다면 *Win_Check_Output.txt*을 생성하는 것이 도움이 될것입니다. 이 파일은 `Win_Check.bat`을 `\util`폴더에서 실행시켜 생성할 수 있습니다. - -## 도커(Docker) -만약 위작업들이 당신에게 좀 어렵게 느껴졌다면 도커(Docker)가 당신을 위한 최선일 수도 있습니다(의역). [Docker CE](https://docs.docker.com/install/#supported-platforms)를 설치한뒤 아래 커맨드를 `qmk_firmware` 디랙토리에서 실행시켜 키보드 또는 키맵을 생성시킵니다. -```bash -util/docker_build.sh keyboard:keymap -# 예: util/docker_build.sh ergodox_ez:steno -``` -이 커맨드는 원하는 키보드 또는 키맵을 컴파일하고 `.hex`또는 `.bin`파일을 프로그램 업로드를(flashing) 위해 QMK디랙토리에 생성할것입니다. 만약 `:keymap`이 생략된다면 `default`이 기본을로 사용됩니다. 참고로 여기서 사용되는 인수는 `make` 커맨드를 사용하여 컴파일할때와 동일합니다. - - -또한 스크립트를 그냥 아무 인수 없이도 사용가능합니다. 그렇게 된다면 프로그램은 하나씩 자동으로 인수입력을 요구 할것입니다. 어쩌면 이방법이 더 쉬울 수도 있습니다. -```bash -util/docker_build.sh -# 인수을 입력받습니다.(아무것도 쓰지 않고 놔두는면 기본값으로 설정됩니다) -``` - -다음과 같이 `target`를 사용하여 컴파일과 프로그램 업로드(flashing)을 동시에 할수도 있습니다. -```bash -util/docker_build.sh keyboard:keymap:target -# 예: util/docker_build.sh planck/rev6:default:dfu-util -``` -만약 당시이 리눅스를 사용한다면 이 커맨드들은 추가 설정 없이 바로 작동할 것입니다. 하지만 위도우 또는 맥 환경에서는 [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)를 사용하는 것을 추천합니다. - -!> 윈도우에서 독커는 [Hyper-V](https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/enable-hyper-v)을 활성화 설정하여야 사용가능합니다. 즉, 도커는 Hyper-V를 지원하지 않는 윈도우 7, 윈도우 8, 그리고 **윈도우 10 홈**과 같은 윈도우 버전에서 사용할수 없다는 것을 의미합니다. - -## Vagrant -만약 컴웨어를 사용하는데 문제가 있다면 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 2ae7917a01..0000000000 --- a/docs/ko-kr/getting_started_getting_help.md +++ /dev/null @@ -1,17 +0,0 @@ -# 도움 받기 - -QMK에서 도움을 받는 방법은 다양합니다. - -**주의, 아래 링크들은 영어로 이루어져 있으며 영어 사용이 가능해야 편리하게 이용할 수 있습니다.** - -## 디스코드 실시간 채팅 - -[QMK 디스코드 서버](https://discord.gg/Uq7gcHh)에서 QMK 개발자들과 실시간으로 대화를 나눌수있습니다. 이 디스코드에는 펌웨어, 툴박스, 하드웨어, 그리고 컨피겨레이터(configurator)에 관한 특별화된 채널이 운영되고 있습니다. - -## OLKB 서브레딧 - -공식 QMK 포럼은 [reddit.com](https://reddit.com) 에 [/r/olkb](https://reddit.com/r/olkb)입니다. - -## Github 이슈 - -[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 4fd8fda6b8..0000000000 --- a/docs/ko-kr/getting_started_github.md +++ /dev/null @@ -1,67 +0,0 @@ -# QMK와 함께 Github를 사용하는 방법 - -Github 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. - -Github는 자주 사용하는 사람이 아니면 좀 여려울수도 있습니다. 이 문서는 Github를 사용하는데 필요한 forking, cloning 그리고 submitting a pull request with QMK를 설명할 것입니다. - -?> 이 가이드는 당신이 git커맨드를 사용하는데 익숙하고 git환경을 당신의 시스템이 설치하였다는 전제하에 작성되었습니다. - -아래와 같이 [QMK Github 페이지](https://github.com/qmk/qmk_firmware)에서 당신은 "Fork"라고 쓰여있는 버튼을 볼 수 있습니다 - - - -만약 당신이 어느기관 소속이고, 무슨 계정을 사용할것인지 골라야 한다면 개인 계정을 사용하는 것을 추천합니다. -"Fork"가 성공적으로 끝났다면 아래 보이는 "Clone or Download"를 눌러야 합니다. - - - -"HTTPS"채크 했는지 확인하고 나와 있는 링크를 복사하세요. - - - -여기거 부터 커맨드라인을 사용합니다. 커맨드 라인에서 `git clone `을 치고 복사한 링크를 붙여넣은후 실행시키세요. - -``` -user@computer:~$ git clone https://github.com/whoeveryouare/qmk_firmware.git -Cloning into 'qmk_firmware'... -remote: Counting objects: 46625, done. -remote: Compressing objects: 100% (2/2), done. -remote: Total 46625 (delta 0), reused 0 (delta 0), pack-reused 46623 -Receiving objects: 100% (46625/46625), 84.47 MiB | 3.14 MiB/s, done. -Resolving deltas: 100% (29362/29362), done. -Checking out files: 100% (2799/2799), done. -``` - -당신은 이제 모든파일이 로컬시스템이 추가 되었습니다 그리고 이제 키맵을 추가하거나 컴파일, 프로그램 업로드(flashing)를 할 수 있습니다. -모든 추가 변경을 만든 뒤에는 add, commit, and push를 사용하여 당신의 Folk에 추가 할 수 있습니다. - -``` -user@computer:~$ git add . -user@computer:~$ git commit -m "adding my keymap" -[master cccb1608] adding my keymap - 1 file changed, 1 insertion(+) - create mode 100644 keyboards/planck/keymaps/mine/keymap.c -user@computer:~$ git push -Counting objects: 1, done. -Delta compression using up to 4 threads. -Compressing objects: 100% (1/1), done. -Writing objects: 100% (1/1), 1.64 KiB | 0 bytes/s, done. -Total 1 (delta 1), reused 0 (delta 0) -remote: Resolving deltas: 100% (1/1), completed with 1 local objects. -To https://github.com/whoeveryouare/qmk_firmware.git - + 20043e64...7da94ac5 master -> master -``` - -이로써 당신이 만든 모든 변경들이 당신의 Github의 Folk에 추가 되었습니다. (`https://github.com/<whoeveryouare>/qmk_firmware`)에서 확인하고 "New Pull Request"를 눌러 변경사항을 QMK에 업로드할수 있습니다. - - - -이 버튼을 누르면 당신이 만든 모든 변경사항들이 보여질 것입니다. 만약 모든 변경사항이 맘에 든다면 "Create Pull Request"를 눌러 요청을 확정할수 있습니다. - -**요청사항이 확정된다고 변경사항이 바로 적용되는 것은 아닙니다.** - - - -요청을 한뒤 QMK개발자들은 댓글로 무엇이 변경되었는지 등을 물어 볼수있지만 끝에는 매인 디랙토리로 업로드 될것입니다. - -**"Thanks for contributing to QMK :)"** diff --git a/docs/pt-br/README.md b/docs/pt-br/README.md deleted file mode 100644 index bf8ec974eb..0000000000 --- a/docs/pt-br/README.md +++ /dev/null @@ -1,30 +0,0 @@ -# Quantum Mechanical Keyboard Firmware - -[](https://github.com/qmk/qmk_firmware/tags) -[](https://discord.gg/Uq7gcHh) -[](https://docs.qmk.fm) -[](https://github.com/qmk/qmk_firmware/pulse/monthly) -[](https://github.com/qmk/qmk_firmware/) - -## O que é o firmware QMK? -QMK (*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. - -## Como obter e usar o QMK - -Se 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. - -Caso 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. - -## Como compilar - -Antes 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: - - make planck/rev4:default - -Isso 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: - - make preonic:default - -## Como personalizar - -O 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 e0a1b45b33..0000000000 --- a/docs/pt-br/_summary.md +++ /dev/null @@ -1,122 +0,0 @@ -* [Complete Newbs Guide](pt-br/newbs.md) - * [Getting Started](pt-br/newbs_getting_started.md) - * [Building Your First Firmware](pt-br/newbs_building_firmware.md) - * [Flashing Firmware](pt-br/newbs_flashing.md) - * [Testing and Debugging](pt-br/newbs_testing_debugging.md) - * [Git Best Practices](pt-br/newbs_best_practices.md) - * [Learning Resources](pt-br/newbs_learn_more_resources.md) - -* [QMK Basics](pt-br/README.md) - * [QMK Introduction](pt-br/getting_started_introduction.md) - * [QMK CLI](pt-br/cli.md) - * [QMK CLI Config](pt-br/cli_configuration.md) - * [Contributing to QMK](pt-br/contributing.md) - * [How to Use GitHub](pt-br/getting_started_github.md) - * [Getting Help](pt-br/getting_started_getting_help.md) - -* [Breaking Changes](pt-br/breaking_changes.md) - * [2019 Aug 30](pt-br/ChangeLog/20190830.md) - -* [FAQ](faq.md) - * [General FAQ](pt-br/faq_general.md) - * [Build/Compile QMK](pt-br/faq_build.md) - * [Debugging/Troubleshooting QMK](pt-br/faq_debug.md) - * [Keymap](pt-br/faq_keymap.md) - * [Driver Installation with Zadig](pt-br/driver_installation_zadig.md) - -* Detailed Guides - * [Install Build Tools](pt-br/getting_started_build_tools.md) - * [Vagrant Guide](pt-br/getting_started_vagrant.md) - * [Build/Compile Instructions](pt-br/getting_started_make_guide.md) - * [Flashing Firmware](pt-br/flashing.md) - * [Customizing Functionality](pt-br/custom_quantum_functions.md) - * [Keymap Overview](pt-br/keymap.md) - -* [Hardware](hardware.md) - * [AVR Processors](pt-br/hardware_avr.md) - * [Drivers](pt-br/hardware_drivers.md) - -* Reference - * [Keyboard Guidelines](pt-br/hardware_keyboard_guidelines.md) - * [Config Options](pt-br/config_options.md) - * [Keycodes](pt-br/keycodes.md) - * [Coding Conventions - C](pt-br/coding_conventions_c.md) - * [Coding Conventions - Python](pt-br/coding_conventions_python.md) - * [Documentation Best Practices](pt-br/documentation_best_practices.md) - * [Documentation Templates](pt-br/documentation_templates.md) - * [Glossary](pt-br/reference_glossary.md) - * [Unit Testing](pt-br/unit_testing.md) - * [Useful Functions](pt-br/ref_functions.md) - * [Configurator Support](pt-br/reference_configurator_support.md) - * [info.json Format](pt-br/reference_info_json.md) - * [Python CLI Development](pt-br/cli_development.md) - -* [Features](pt-br/features.md) - * [Basic Keycodes](pt-br/keycodes_basic.md) - * [US ANSI Shifted Keys](pt-br/keycodes_us_ansi_shifted.md) - * [Quantum Keycodes](pt-br/quantum_keycodes.md) - * [Advanced Keycodes](pt-br/feature_advanced_keycodes.md) - * [Audio](pt-br/feature_audio.md) - * [Auto Shift](pt-br/feature_auto_shift.md) - * [Backlight](pt-br/feature_backlight.md) - * [Bluetooth](pt-br/feature_bluetooth.md) - * [Bootmagic](pt-br/feature_bootmagic.md) - * [Combos](pt-br/feature_combo.md) - * [Command](pt-br/feature_command.md) - * [Debounce API](pt-br/feature_debounce_type.md) - * [DIP Switch](pt-br/feature_dip_switch.md) - * [Dynamic Macros](pt-br/feature_dynamic_macros.md) - * [Encoders](pt-br/feature_encoders.md) - * [Grave Escape](pt-br/feature_grave_esc.md) - * [Haptic Feedback](pt-br/feature_haptic_feedback.md) - * [HD44780 LCD Controller](pt-br/feature_hd44780.md) - * [Key Lock](pt-br/feature_key_lock.md) - * [Layouts](pt-br/feature_layouts.md) - * [Leader Key](pt-br/feature_leader_key.md) - * [LED Matrix](pt-br/feature_led_matrix.md) - * [Macros](pt-br/feature_macros.md) - * [Mouse Keys](pt-br/feature_mouse_keys.md) - * [OLED Driver](pt-br/feature_oled_driver.md) - * [One Shot Keys](pt-br/one_shot_keys.md) - * [Pointing Device](pt-br/feature_pointing_device.md) - * [PS/2 Mouse](pt-br/feature_ps2_mouse.md) - * [RGB Lighting](pt-br/feature_rgblight.md) - * [RGB Matrix](pt-br/feature_rgb_matrix.md) - * [Space Cadet](pt-br/feature_space_cadet.md) - * [Split Keyboard](pt-br/feature_split_keyboard.md) - * [Stenography](pt-br/feature_stenography.md) - * [Swap Hands](pt-br/feature_swap_hands.md) - * [Tap Dance](pt-br/feature_tap_dance.md) - * [Terminal](pt-br/feature_terminal.md) - * [Thermal Printer](pt-br/feature_thermal_printer.md) - * [Unicode](pt-br/feature_unicode.md) - * [Userspace](pt-br/feature_userspace.md) - * [Velocikey](pt-br/feature_velocikey.md) - -* For Makers and Modders - * [Hand Wiring Guide](pt-br/hand_wire.md) - * [ISP Flashing Guide](pt-br/isp_flashing_guide.md) - * [ARM Debugging Guide](pt-br/arm_debugging.md) - * [I2C Driver](pt-br/i2c_driver.md) - * [SPI Driver](pt-br/spi_driver.md) - * [GPIO Controls](pt-br/internals_gpio_control.md) - * [Proton C Conversion](pt-br/proton_c_conversion.md) - -* For a Deeper Understanding - * [How Keyboards Work](pt-br/how_keyboards_work.md) - * [Understanding QMK](pt-br/understanding_qmk.md) - -* Other Topics - * [Using Eclipse with QMK](pt-br/other_eclipse.md) - * [Using VSCode with QMK](pt-br/other_vscode.md) - * [Support](pt-br/getting_started_getting_help.md) - * [How to add translations](pt-br/translating.md) - -* QMK Internals (In Progress) - * [Defines](pt-br/internals_defines.md) - * [Input Callback Reg](pt-br/internals_input_callback_reg.md) - * [Midi Device](pt-br/internals_midi_device.md) - * [Midi Device Setup Process](pt-br/internals_midi_device_setup_process.md) - * [Midi Util](pt-br/internals_midi_util.md) - * [Send Functions](pt-br/internals_send_functions.md) - * [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 7218781540..0000000000 --- a/docs/ru-ru/README.md +++ /dev/null @@ -1,31 +0,0 @@ -# Quantum Mechanical Keyboard Firmware - -[](https://github.com/qmk/qmk_firmware/tags) -[](https://discord.gg/Uq7gcHh) -[](https://docs.qmk.fm) -[](https://github.com/qmk/qmk_firmware/pulse/monthly) -[](https://github.com/qmk/qmk_firmware/) - -## Что такое QMK Firmware? - -QMK (*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. Вы можете использовать ее для клавиатуры, собранной вручную или имеющей нестандартную печатную плату. - -## Как скачать - -Если вы собираетесь добавить раскладку, клавиатуру или новые функции в QMK, то самый простой путь реализации — это [сделать форк репозитория на GitHub](https://github.com/qmk/qmk_firmware#fork-destination-box), клонировать ваш репозиторий локально для дальнейшего внесения изменений, сделать пуш изменений, а затем открыть [пулреквест](https://github.com/qmk/qmk_firmware/pulls) из вашего форка. - -Также вы можете либо скачать репозиторий ([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`). - -## Как скомпилировать - -Перед компиляцией вам необходимо [настроить окружение](ru-ru/getting_started_build_tools.md) разработчика для AVR или/и ARM. После этого используйте команду `make` со следующим синтаксисом, чтобы собрать клавиатуру и раскладку: - - make planck/rev4:default - -Данная команда соберет ревизию `rev4` клавиатуры `planck` с раскладкой `default`. Не все клавиатуры имеют ревизии (они также называются subprojects или folders), в этом случае она может быть опущена: - - make preonic:default - -## Как настроить - -QMK обладает множеством [функций](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 09273172b6..0000000000 --- a/docs/ru-ru/_summary.md +++ /dev/null @@ -1,124 +0,0 @@ -* [Complete Newbs Guide](ru-ru/newbs.md) - * [Getting Started](ru-ru/newbs_getting_started.md) - * [Building Your First Firmware](ru-ru/newbs_building_firmware.md) - * [Flashing Firmware](ru-ru/newbs_flashing.md) - * [Testing and Debugging](ru-ru/newbs_testing_debugging.md) - * [Git Best Practices](ru-ru/newbs_best_practices.md) - * [Learning Resources](ru-ru/newbs_learn_more_resources.md) - -* [QMK Basics](ru-ru/README.md) - * [QMK Introduction](ru-ru/getting_started_introduction.md) - * [QMK CLI](ru-ru/cli.md) - * [QMK CLI Config](ru-ru/cli_configuration.md) - * [Contributing to QMK](ru-ru/contributing.md) - * [How to Use GitHub](ru-ru/getting_started_github.md) - * [Getting Help](ru-ru/getting_started_getting_help.md) - -* [Breaking Changes](ru-ru/breaking_changes.md) - * [2019 Aug 30](ru-ru/ChangeLog/20190830.md) - -* [FAQ](ru-ru/faq.md) - * [General FAQ](ru-ru/faq_general.md) - * [Build/Compile QMK](ru-ru/faq_build.md) - * [Debugging/Troubleshooting QMK](ru-ru/faq_debug.md) - * [Keymap](ru-ru/faq_keymap.md) - * [Driver Installation with Zadig](ru-ru/driver_installation_zadig.md) - -* Detailed Guides - * [Install Build Tools](ru-ru/getting_started_build_tools.md) - * [Vagrant Guide](ru-ru/getting_started_vagrant.md) - * [Build/Compile Instructions](ru-ru/getting_started_make_guide.md) - * [Flashing Firmware](ru-ru/flashing.md) - * [Customizing Functionality](ru-ru/custom_quantum_functions.md) - * [Keymap Overview](ru-ru/keymap.md) - -* [Hardware](ru-ru/hardware.md) - * [Compatible Microcontrollers](ru-ru/compatible_microcontrollers.md) - * [AVR Processors](ru-ru/hardware_avr.md) - * [Drivers](ru-ru/hardware_drivers.md) - -* Reference - * [Keyboard Guidelines](ru-ru/hardware_keyboard_guidelines.md) - * [Config Options](ru-ru/config_options.md) - * [Keycodes](ru-ru/keycodes.md) - * [Coding Conventions - C](ru-ru/coding_conventions_c.md) - * [Coding Conventions - Python](ru-ru/coding_conventions_python.md) - * [Documentation Best Practices](ru-ru/documentation_best_practices.md) - * [Documentation Templates](ru-ru/documentation_templates.md) - * [Glossary](ru-ru/reference_glossary.md) - * [Unit Testing](ru-ru/unit_testing.md) - * [Useful Functions](ru-ru/ref_functions.md) - * [Configurator Support](ru-ru/reference_configurator_support.md) - * [info.json Format](ru-ru/reference_info_json.md) - * [Python CLI Development](ru-ru/cli_development.md) - -* [Features](ru-ru/features.md) - * [Basic Keycodes](ru-ru/keycodes_basic.md) - * [US ANSI Shifted Keys](ru-ru/keycodes_us_ansi_shifted.md) - * [Quantum Keycodes](ru-ru/quantum_keycodes.md) - * [Advanced Keycodes](ru-ru/feature_advanced_keycodes.md) - * [Audio](ru-ru/feature_audio.md) - * [Auto Shift](ru-ru/feature_auto_shift.md) - * [Backlight](ru-ru/feature_backlight.md) - * [Bluetooth](ru-ru/feature_bluetooth.md) - * [Bootmagic](ru-ru/feature_bootmagic.md) - * [Combos](ru-ru/feature_combo.md) - * [Command](ru-ru/feature_command.md) - * [Debounce API](ru-ru/feature_debounce_type.md) - * [DIP Switch](ru-ru/feature_dip_switch.md) - * [Dynamic Macros](ru-ru/feature_dynamic_macros.md) - * [Encoders](ru-ru/feature_encoders.md) - * [Grave Escape](ru-ru/feature_grave_esc.md) - * [Haptic Feedback](ru-ru/feature_haptic_feedback.md) - * [HD44780 LCD Controller](ru-ru/feature_hd44780.md) - * [Key Lock](ru-ru/feature_key_lock.md) - * [Layouts](ru-ru/feature_layouts.md) - * [Leader Key](ru-ru/feature_leader_key.md) - * [LED Matrix](ru-ru/feature_led_matrix.md) - * [Macros](ru-ru/feature_macros.md) - * [Mouse Keys](ru-ru/feature_mouse_keys.md) - * [OLED Driver](ru-ru/feature_oled_driver.md) - * [One Shot Keys](ru-ru/one_shot_keys.md) - * [Pointing Device](ru-ru/feature_pointing_device.md) - * [PS/2 Mouse](ru-ru/feature_ps2_mouse.md) - * [RGB Lighting](ru-ru/feature_rgblight.md) - * [RGB Matrix](ru-ru/feature_rgb_matrix.md) - * [Space Cadet](ru-ru/feature_space_cadet.md) - * [Split Keyboard](ru-ru/feature_split_keyboard.md) - * [Stenography](ru-ru/feature_stenography.md) - * [Swap Hands](ru-ru/feature_swap_hands.md) - * [Tap Dance](ru-ru/feature_tap_dance.md) - * [Terminal](ru-ru/feature_terminal.md) - * [Thermal Printer](ru-ru/feature_thermal_printer.md) - * [Unicode](ru-ru/feature_unicode.md) - * [Userspace](ru-ru/feature_userspace.md) - * [Velocikey](ru-ru/feature_velocikey.md) - -* For Makers and Modders - * [Hand Wiring Guide](ru-ru/hand_wire.md) - * [ISP Flashing Guide](ru-ru/isp_flashing_guide.md) - * [ARM Debugging Guide](ru-ru/arm_debugging.md) - * [I2C Driver](ru-ru/i2c_driver.md) - * [SPI Driver](ru-ru/spi_driver.md) - * [WS2812 Driver](ru-ru/ws2812_driver.md) - * [GPIO Controls](ru-ru/internals_gpio_control.md) - * [Proton C Conversion](ru-ru/proton_c_conversion.md) - -* For a Deeper Understanding - * [How Keyboards Work](ru-ru/how_keyboards_work.md) - * [Understanding QMK](ru-ru/understanding_qmk.md) - -* Other Topics - * [Using Eclipse with QMK](ru-ru/other_eclipse.md) - * [Using VSCode with QMK](ru-ru/other_vscode.md) - * [Support](ru-ru/getting_started_getting_help.md) - * [Translating the QMK Docs](ru-ru/translating.md) - -* QMK Internals (In Progress) - * [Defines](ru-ru/internals_defines.md) - * [Input Callback Reg](ru-ru/internals_input_callback_reg.md) - * [Midi Device](ru-ru/internals_midi_device.md) - * [Midi Device Setup Process](ru-ru/internals_midi_device_setup_process.md) - * [Midi Util](ru-ru/internals_midi_util.md) - * [Send Functions](ru-ru/internals_send_functions.md) - * [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 322f9a9e59..0000000000 --- a/docs/ru-ru/getting_started_build_tools.md +++ /dev/null @@ -1,153 +0,0 @@ -# Установка инструментов для сборки - -Данная страница описывает процесс установки окружения для сборки QMK. Эти инструкции относятся к процессорам AVR (таким как atmega32u4). - -<!-- FIXME: Нужно написать и добавить куда-нибудь инструкции для ARM. --> - -**Примечание:** Если вы здесь впервые, ознакомьтесь с [Руководством для полных новичков](ru-ru/newbs.md). - -Прежде, чем продолжить, убедитесь, что у вас обновлены подмодули (сторонние библиотеки), выполнив `make git-submodule`. - -## Linux - -Чтобы всегда быть уверенными, что у вас установлены последние версии ПО, можно просто выполнить команду `sudo util/qmk_install.sh`. Она должна установить все необходимые зависимости. **Это выполнит `apt-get upgrade`.** - -Вы также можете устанавливать все вручную, но в данной документации список требований может не всегда быть актуальным. - -Текущие требования представлены ниже, но не все они могут быть необходимы, так как зависят от того, что вы делаете. Также стоит отметить, что в некоторых системах не все зависимости доступны в виде пакетов, или они могут называться по-другому. - -``` -build-essential -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 -git -``` - -Установите все зависимости при помощи вашего любимого менеджера пакетов. - -Пример для Debian / Ubuntu: - - sudo apt-get update - 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 - -Пример для Fedora / Red Hat: - - 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 - -Пример для Arch / Manjaro: - - 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 - -## Nix - -Если вы используете [NixOS](https://nixos.org/), или у вас установлена Nix в Linux или macOS, выполните `nix-shell` из корня репозитория, чтобы настроить окружение для сборки. - -По умолчанию, это скачает компиляторы для AVR и ARM. Если вам не нужны они оба, отключите `avr` или `arm` с помощью аргумента, например: - - nix-shell --arg arm false - -## macOS - -Если вы пользуетесь [Homebrew](https://brew.sh/), вы можете использовать следующие команды: - - brew tap osx-cross/avr - brew tap PX4/homebrew-px4 - brew update - brew install avr-gcc@8 - brew link --force avr-gcc@8 - brew install dfu-programmer - brew install dfu-util - brew install gcc-arm-none-eabi - brew install avrdude - -Данный метод является рекомендуемым. Если у вас нет Homebrew, [установите его!](https://brew.sh/) Он очень сильно пригодится тем, кто работает с командной строкой. Стоит отметить, что часть с `make` и `make install` во время установки `avr-gcc@8` из Homebrew может занимать более 20 минут и сильно нагружать CPU. - -## Windows с MSYS2 (рекомендуется) - -Наилучшим окружение для Windows Vista и всех последующих версий (тестировалось с 7 и 10) является [MSYS2](https://www.msys2.org). - -* Для установки MSYS2, скачайте его и следуйте дальнейшим указаниям отсюда: https://www.msys2.org -* Откройте ``MSYS2 MingGW 64-bit`` ярлык -* Перейдите в свой репозиторий QMK. Например, если он находится в корне вашего диска C: - * `$ cd /c/qmk_firmware` -* Запустите `util/qmk_install.sh` и следуйте подсказкам - -## Windows 10 (устарело) - -Это устаревшие инструкции для Windows 10. Мы рекомендуем использовать [MSYS2, как сказано выше](#windows-с-msys2-рекомендуется). - -### Обновление для дизайнеров (Creators Update) - -Если у вас Windows 10 с Обновлением для дизайнеров или новее, вы можете собрать прошивку и прошить ей напрямую. До Обновления для дизайнеров было возможно только собрать прошивку. Если у вас его еще нет, или вы не уверены, следуйте [этим инструкциям](https://support.microsoft.com/en-us/instantanswers/d4efb316-79f0-1aa1-9ef3-dcada78f3fa0/get-the-windows-10-creators-update). - -### Подсистема Windows для Linux (Windows Subsystem for Linux, WSL) - -В дополнение к Обновлению для дизайнеров вам необходима подсистема 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`. - -### Git - -Если вы уже клонировали репозиторий в файловую систему Windows, вы можете пропустить данную секцию. - -Вам нужно клонировать репозиторий в файловую систему 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). Важно указать свой адрес электронной почты и имя пользователя, особенно если вы планируете вносить свой вклад в проект. - -Как только 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` в текущей директории. - -### Установка инструментов (Toolchain) - -Установка инструментов (Toolchain) осуществляется через подсистему Windows для Linux, и процесс полностью автоматизирован. Если вы хотите выполнить установку вручную, то не существует никакой другой инструкции помимо самого скрипта. Однако, вы всегда можете открыть ишью и запросить дополнительную информацию. - -1. Откройте "Bash On Ubuntu On Windows" в меню Пуск. -2. Перейдите в папку, в которую клонирована `qmk_firmware`. Обратите внимание, что пути начинаются с `/mnt/` в WSL, так что вы должны написать, например, `cd /mnt/c/path/to/qmk_firmware`. -3. Запустите `util/wsl_install.sh` и следуйте инструкциям на экране. -4. Закройте окно командной строки Bash, и откройте его снова. -5. Все готово, чтобы скомпилировать прошивку и прошить ей! - -### Несколько важных вещей, которые надо запомнить - -* Вы можете запустить `util/wsl_install.sh` еще раз, чтобы установить все последние обновления. -* Ваш репозиторий QMK должен находиться в файловой системе Windows, поскольку WSL не может запускать выполняемые файлы извне. -* WSL Git **не** совместим с Windows Git, поэтому используйте Windows Git Bash или Windows Git GUI для всех операций с Git. -* Вы можете изменять файлы как внутри WSL, так и просто через Windows. Но обратите внимание, что если вы изменяете makefiles или сценарии командной строки, вы должны убедиться, что используете текстовый редактор, который сохраняет файлы с переводом строки в стиле Unix (Unix line endings). В противном случае компиляция может не работать. - -## Docker - -Если это немного сложновато для вас, Docker может стать готовым решением, которое вы ищите. После установки [Docker CE](https://docs.docker.com/install/#supported-platforms) выполните следующую команду из директории `qmk_firmware`, чтобы собрать клавиатуру/раскладку: - -```bash -util/docker_build.sh keyboard:keymap -# Например: util/docker_build.sh ergodox_ez:steno -``` - -Это скомпилирует указанную клавиатуру/раскладку и создаст для вас `.hex` или `.bin` файл с результатом, готовым к процессу прошивки, в директории QMK. Если опустить `:keymap`, будет использована раскладка `default`. Заметьте, что формат параметров такой же, как и в случае сборки командой `make`. - -Вы также можете запустить скрипт без параметров. Тогда он попросит вас ввести поочередно параметры сборки. Возможно, вам это покажется более удобным: - -```bash -util/docker_build.sh -# Читает параметры из пользовательского ввода (оставьте пустым для значений по умолчанию) -``` - -Также имеется поддержка сборки _и_ прошивки клавиатуры прямо из Docker. Для этого укажите еще один параметр `target`: - -```bash -util/docker_build.sh keyboard:keymap:target -# Например: util/docker_build.sh planck/rev6:default:dfu-util -``` - -Если вы используете 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). - -!> 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**. - -## Vagrant - -Если у вас возникли проблемы при сборке прошивки, вы можете попробовать установить инструмент под названием 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 75be44310e..0000000000 --- a/docs/ru-ru/getting_started_getting_help.md +++ /dev/null @@ -1,15 +0,0 @@ -# Получение помощи - -Существует много ресурсов для получения помощи по работе с QMK. - -## Чат в реальном времени - -Вы можете найти разработчиков и пользователей QMK на нашем главном [сервере Discord](https://discord.gg/Uq7gcHh). На сервере есть специальные каналы для разговоров о прошивке, Toolbox, оборудовании и конфигураторе. - -## OLKB Сабреддит - -Официальный форум QMK [/r/olkb](https://reddit.com/r/olkb) на [reddit.com](https://reddit.com). - -## GitHub ишью - -Вы можете открыть [ишью на 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 7a70926f50..0000000000 --- a/docs/ru-ru/getting_started_github.md +++ /dev/null @@ -1,63 +0,0 @@ -# Как использовать GitHub с QMK - -GitHub может показаться несколько сложным для тех, кто никогда с ним не работал. В данном руководстве будет разобран каждый шаг создания форка, клонирования и отправки пулреквеста в QMK. - -?> В этом руководстве предполагается, что вы в какой-то степени знакомы с работой в командной строке, и в вашей системе установлен git. - -Откройте [страницу QMK на GitHub] (https://github.com/qmk/qmk_firmware), и в правом верхнем углу вы увидите кнопку с надписью "Fork": - - - -Если вы состоите в какой-либо организации, вам нужно выбрать учетную запись, к которой будет привязан форк. В большинстве случаев это будет личной аккаунт. Как только ваш форк будет завершен (иногда это занимает немного времени), нажмите кнопку "Clone or Download": - - -И обязательно выберите "HTTPS", затем выделите ссылку и скопируйте ее: - - - -Теперь введите `git clone --recurse-submodules ` в командную строку, а затем вставьте ссылку: - -``` -user@computer:~$ git clone --recurse-submodules https://github.com/whoeveryouare/qmk_firmware.git -Cloning into 'qmk_firmware'... -remote: Enumerating objects: 9, done. -remote: Counting objects: 100% (9/9), done. -remote: Compressing objects: 100% (5/5), done. -remote: Total 183883 (delta 5), reused 4 (delta 4), pack-reused 183874 -Receiving objects: 100% (183883/183883), 132.90 MiB | 9.57 MiB/s, done. -Resolving deltas: 100% (119972/119972), done. -... -Submodule path 'lib/chibios': checked out '587968d6cbc2b0e1c7147540872f2a67e59ca18b' -Submodule path 'lib/chibios-contrib': checked out 'ede48346eee4b8d6847c19bc01420bee76a5e486' -Submodule path 'lib/googletest': checked out 'ec44c6c1675c25b9827aacd08c02433cccde7780' -Submodule path 'lib/lufa': checked out 'ce10f7642b0459e409839b23cc91498945119b4d' -``` - -Теперь у вас есть форк QMK на вашем локальном компьютере, и вы можете добавить свою раскладку, скомпилировать ее и прошить ей свою клавиатуру. Как только вы будете довольны своими изменениями, есть возможность добавить, зафиксировать их и сделать коммит в свой форк следующим образом: - -``` -user@computer:~$ git add . -user@computer:~$ git commit -m "adding my keymap" -[master cccb1608] adding my keymap - 1 file changed, 1 insertion(+) - create mode 100644 keyboards/planck/keymaps/mine/keymap.c -user@computer:~$ git push -Counting objects: 1, done. -Delta compression using up to 4 threads. -Compressing objects: 100% (1/1), done. -Writing objects: 100% (1/1), 1.64 KiB | 0 bytes/s, done. -Total 1 (delta 1), reused 0 (delta 0) -remote: Resolving deltas: 100% (1/1), completed with 1 local objects. -To https://github.com/whoeveryouare/qmk_firmware.git - + 20043e64...7da94ac5 master -> master -``` - -Ваши изменения теперь существуют в вашем форке на GitHub - если вернуться туда (`https://github.com/<whoeveryouare>/qmk_firmware`), вы сможете создать "New Pull Request" нажатием на кнопку: - - - -Здесь вы сможете увидеть, какие именно изменения были внесены, - если все выглядит хорошо, вы можете завершить его, нажав "Create Pull Request": - - - -После отправки мы можем расспросить вас о ваших изменениях, попросить внести корректировки и в конечном итоге принять их! Спасибо за ваш вклад в QMK :) diff --git a/docs/ru-ru/getting_started_introduction.md b/docs/ru-ru/getting_started_introduction.md deleted file mode 100644 index ccc4418068..0000000000 --- a/docs/ru-ru/getting_started_introduction.md +++ /dev/null @@ -1,58 +0,0 @@ -# Введение - -Эта страница пытается объяснить основную информацию, которую вы должны знать, чтобы работать с проектом QMK. Предполагается, что вы знакомы с навигацией в оболочке Unix, но не предполагается, что вы знакомы с C или с компиляцией с использованием make. - -## Базовая структура QMK - -QMK - это форк [Джуна Вако (Jun Wako)](https://github.com/tmk) проекта [tmk_keyboard](https://github.com/tmk/tmk_keyboard). Оригинальный код TMK с изменениями можно найти в папке `tmk_core`. Дополнения QMK к проекту можно найти в папке `quantum`. Проекты клавиатур можно найти в папках `handwired` и `keyboard`. - -### Структура пространства пользователя - -Внутри папки `users` находится каталог для каждого пользователя. Это место для пользователей, куда они могут поместить код, чтобы использовать его с разными клавиатурами. Для получения дополнительной информации обратитесь к документации по [функциям пользовательского пространства](ru-ru/feature_userspace.md). - -### Структура проекта клавиатуры - -Внутри папки `keyboards` есть подпапки `handwired` и есть подкаталоги поставщиков и производителей, для примера, `clueboard` - это каталог для каждого проекта клавиатуры, например, `qmk_firmware/keyboards/clueboard/2x1800`. В нем вы найдете следующую структуру: -* `keymaps/`: Различные раскладки клавиш, которые можно собрать. -* `rules.mk`: Файл, который устанавливает параметры по умолчанию для команды "make". Не редактируйте этот файл напрямую, вместо этого используйте `rules.mk`, относящийся к конкретной раскладке. -* `config.h`: Файл, который устанавливает параметры времени компиляции по умолчанию. Не редактируйте этот файл напрямую, вместо этого используйте `config.h`, относящийся к конкретной раскладке. -* `info.json`: Файл настройки раскладки для QMK Configurator. Посмотрите [Поддержку конфигуратора](ru-ru/reference_configurator_support.md) для дополнительной информации. -* `readme.md`: Краткий обзор клавиатуры. -* `<keyboardName>.h`: В этом файле определяется раскладка клавиатуры по матрице переключателей клавиатуры. -* `<keyboardName>.c`: В этом файле вы можете найти пользовательский код для клавиатуры. - -Для получения дополнительной информации о структуре проекта обратитесь к [Руководству QMK по клавиатуре](ru-ru/hardware_keyboard_guidelines.md). - -### Структура раскладки клавиатуры - -В каждой папке раскладки клавиатуры могут быть найдены следующие файлы. Обязательным является только файл `keymap.c`, и если остальные файлы не найдены, то будут выбраны параметры по умолчанию. - -* `config.h`: настройки вашей раскладки клавиатуры. -* `keymap.c`: весь код вашей раскладки клавиатуры (обязателен). -* `rules.mk`: активированные функции QMK. -* `readme.md`: описание вашей раскладки клавиш, как ее могут использовать другие, и объяснения функций. Пожалуйста, загрузите изображения на сервис, такой как imgur. - -# Файл `config.h` - -Существует 3 возможных местоположения `config.h`: - -* клавиатура (`/keyboards/<keyboard>/config.h`) -* пространство пользователя (`/users/<user>/config.h`) -* раскладка клавиш (`/keyboards/<keyboard>/keymaps/<keymap>/config.h`) - -Система сборки автоматически загружает файлы конфигурации в указанном выше порядке. Если вы хотите переопределить любую настройку, заданную предыдущим `config.h`, вам сначала нужно будет включить некоторый шаблонный код для настроек, которые вы хотите изменить. - -``` -#pragma once -``` - -Затем, чтобы переопределить настройку из предыдущего файла `config.h`, вы должны сделать `#undef` и `#define` для неё снова. - -Код и настройка шаблона вместе выглядят так: -``` -#pragma once - -// Переопределения производятся здесь! -#undef MY_SETTING -#define MY_SETTING 4 -``` diff --git a/docs/ru-ru/newbs.md b/docs/ru-ru/newbs.md deleted file mode 100644 index 0e7bd6499c..0000000000 --- a/docs/ru-ru/newbs.md +++ /dev/null @@ -1,23 +0,0 @@ -# Руководство по QMK для полных новичков - -QMK ― это мощная прошивка с открытым исходным кодом для вашей механической клавиатуры. Вы можете использовать QMK для легкой и мощной персонализации своей клавиатуры. Люди с разным уровнем умений, от совсем новичков до крутых программистов, успешно применяли QMK, чтобы персонализировать свои клавиатуры. Данное руководство поможет вам сделать то же самое, независимо от уровня вашего мастерства. - -Не уверены, поддерживает ли ваша клавиатура QMK? Если это механическая клавиатура, которую вы собрали сами, шансы достаточно велики. Мы поддерживаем [большое число любительских клавиатур](https://qmk.fm/keyboards/), поэтому, даже если ваша текущая клавиатура не совместима с QMK, у вас не должно возникнуть проблем с нахождением подходящей для ваших нужд. - -## Обзор - -В данном руководстве 7 основных секций: - -* [Первое знакомство](ru-ru/newbs_getting_started.md) -* [Собираем вашу первую прошивку с помощью командной строки](ru-ru/newbs_building_firmware.md) -* [Собираем вашу первую прошивку с помощью онлайн GUI](ru-ru/newbs_building_firmware_configurator.md) -* [Прошиваем файл прошивки](ru-ru/newbs_flashing.md) -* [Тестируем и отлаживаем](ru-ru/newbs_testing_debugging.md) -* [Лучшие практики по Git](ru-ru/newbs_best_practices.md) -* [Узнайте больше на этих ресурсах](ru-ru/newbs_learn_more_resources.md) - -Данное руководство сосредоточено на помощи тем, кто никогда раньше не компилировал ПО. Приятие решений и рекомендации делаются с учетом именно этого. Существует много альтернативных методов для описанных процедур, и мы поддерживаем большинство из них. Если у вас есть сомнения о том, как выполнить задачу, вы можете [попросить у нас совета](ru-ru/getting_started_getting_help.md). - -## Дополнительные ресурсы - -* [Блог Томаса Баарта (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 a301e9adba..0000000000 --- a/docs/ru-ru/newbs_getting_started.md +++ /dev/null @@ -1,102 +0,0 @@ -# Введение - -У вашей компьютерной клавиатуры внутри есть процессор, похожий на тот, что внутри вашего компьютера. Этот процессор выполняет программное обеспечение, которое отвечает за обнаружение нажатий клавиш и отсылку сигналов состояния клавиатуры, когда клавиши нажимаются и отпускаются. Роль такого ПО выполняет QMK, детектируя нажатия клавиш и отсылая эту информацию главному компьютеру. Сбор собственной раскладки эквивалентен сборке выполняемой программы для вашей клавиатуры. - -QMK старается дать вам большую силу, оставляя простые вещи легкими и делай сложные — возможными. Вам не надо уметь программировать, чтобы создавать мощные прошивки — вам только надо следовать нескольким простым синтаксическим правилам. - -# Первое знакомство - -Перед тем, как вы сможете собирать раскладки, вам необходимо установить некоторое программное обеспечение и настроить ваше окружение для сборки. Это нужно сделать только один раз, вне зависимости от того, для скольких клавиатур вы планируете компилировать прошивки. - -Если вы предпочитаете графический пользовательский интерфейс, пожалуйста, рассмотрите возможность использования онлайн [QMK Конфигуратора](https://config.qmk.fm). Пожалуйста, обратитесь к [Собираем вашу первую прошивку с помощью онлайн GUI](ru-ru/newbs_building_firmware_configurator.md). - - -## Загрузка ПО - -### Текстовый редактор - -Вам понадобится программа, умеющая редактировать и сохранять **обычные текстовые** файлы. Если вы используете Windows, вы можете делать это Блокнотом, а в Linux вы можете использовать gedit. Обе программы являются простыми, но функциональными редакторами. В macOS остерегайтесь стандартного приложения TextEdit: он не будет сохранять обычные текстовые файлы, пока вы явно не выберите _Make Plain Text_ из меню _Format_. - -Вы также можете скачать и установить отдельный текстовый редактор наподобие [Sublime Text](https://www.sublimetext.com/) или [VS Code](https://code.visualstudio.com/). Возможно, это наилучший вариант независимо от платформы, поскольку эти программы сделаны специально для редактирования кода. - -?> Не уверены, какой выбрать текстовый редактор? Лоуренс Брэдфорд (Laurence Bradford) написал [отличное введение](https://learntocodewith.me/programming/basics/text-editors/) в тему. - -### QMK Toolbox - -QMK Toolbox является дополнительной графической программой для Windows и macOS, которая позволяет вам разрабатывать и отлаживать вашу клавиатуру. Вы, вероятно, посчитаете ее бесценной для легкого процесса прошивки вашей клавиатуры и просмотра отладочных сообщений, которые она отображает. - -[Скачайте последний выпуск здесь.](https://github.com/qmk/qmk_toolbox/releases/latest) - -* Для Windows: `qmk_toolbox.exe` (переносимое приложение) или `qmk_toolbox_install.exe` (установщик) -* Для macOS: `QMK.Toolbox.app.zip` (переносимое приложение) или `QMK.Toolbox.pkg` (установщик) - -## Настройте ваше окружение - -Мы постарались сделать установку QMK максимально легкой. Вам нужно только подготовить ваше Linux или Unix окружение, после этого позвольте QMK установить все остальное. - -?> Если вы никогда раньше не работали с командной строкой Linux/Unix, существует несколько базовых концептов и команд, которые необходимо выучить. Эти ресурсы дадут вам достаточно знаний, чтобы работать с QMK:<br> -[Обязательные к изучению команды Linux](https://www.guru99.com/must-know-linux-commands.html)<br> -[Несколько базовых команд Unix](https://www.tjhsst.edu/~dhyatt/superap/unixcmd.html) - -### Windows - -Вам нужно будет установить MSYS2 и Git. - -* Следуйте инструкциям по установки на [домашней странице MSYS2](https://www.msys2.org). -* Закройте все открытые терминалы MSYS2 и откройте новый терминал MSYS2 MinGW 64-bit. -* Установите Git, выполнив эту команду: `pacman -S git`. - -### macOS - -Вам нужно будет установить Homebrew. Следуйте инструкциям на [домашней странице Homebrew](https://brew.sh). - -После установки Homebrew продолжите чтение с _Установите QMK_. На этом шаге вам надо будет запустить скрипт, который установит остальные пакеты. - -### Linux - -Вам нужно будет установить Git. Скорее всего, он у вас уже есть, но если нет, одна из следующих команд должна установить его: - -* Debian / Ubuntu / Devuan: `apt-get install git` -* Fedora / Red Hat / CentOS: `yum install git` -* Arch: `pacman -S git` - -?> Docker также является вариантом для всех платформ. [Нажмите сюда для получения подробностей.](ru-ru/getting_started_build_tools.md#docker) - -## Установите QMK - -Как только вы настроили ваше Linux/Unix окружение, вы готовы к загрузке QMK. Мы сделаем это при помощи Git, "клонировав" репозиторий QMK. Откройте Терминал или окно MSYS2 MinGW и оставьте его открытым до конца данного руководства. Выполните эти команды внутри него: - -```shell -git clone --recurse-submodules https://github.com/qmk/qmk_firmware.git -cd qmk_firmware -``` - -?> Если вы уже знаете, [как пользоваться GitHub](ru-ru/getting_started_github.md), мы рекомендуем вам вместо этого создать и клонировать свой собственный форк. Если вы не понимаете, что это значит, просто проигнорируйте это сообщение. - -QMK включает в себя скрипт, который поможет вам установить все оставшееся, что вам понадобится. Вы должны запустить его, набрав эту команду: - - util/qmk_install.sh - -## Протестируйте ваше окружение для сборки - -Теперь, когда ваше окружение QMK для сборки настроено, вы можете собрать прошивку для вашей клавиатуры. Начните с попытки собрать раскладку для клавиатуры по умолчанию. У вас должно это получиться с помощью команды в этом формате: - - make <keyboard>:default - -Например, чтобы собрать прошивку для Clueboard 66%, вы введете: - - make clueboard/66/rev3:default - -Когда все закончится, вы должны увидеть большой лог, который заканчивается примерно так: - -``` -Linking: .build/clueboard_66_rev3_default.elf [OK] -Creating load file for flashing: .build/clueboard_66_rev3_default.hex [OK] -Copying clueboard_66_rev3_default.hex to qmk_firmware folder [OK] -Checking file size of clueboard_66_rev3_default.hex [OK] - * The firmware size is fine - 26356/28672 (2316 bytes free) -``` - -# Создаем вашу раскладку - -Теперь вы готовы создать свою персональную раскладку! Для этого перейдите к [Собираем вашу первую прошивку](ru-ru/newbs_building_firmware.md). |