diff options
78 files changed, 0 insertions, 6668 deletions
diff --git a/book.json b/book.json deleted file mode 100644 index 79206bf35a..0000000000 --- a/book.json +++ /dev/null @@ -1,46 +0,0 @@ -{ - "structure": { - "summary": "_summary.md" - }, - "plugins" : [ - "edit-link", - "forkmegithub", - "hints", - "page-toc", - "terminal", - "toolbar", - "bulk-redirect" - ], - "pluginsConfig": { - "edit-link": { - "base": "https://github.com/qmk/qmk_firmware/edit/master/docs", - "label": "Suggest an edit" - }, - "forkmegithub": { - "color": "red", - "url": "https://github.com/qmk/qmk_firmware" - }, - "page-toc": { - "selector": ".markdown-section h1, .markdown-section h2" - }, - "terminal": { - "copyButtons": true, - "fade": false, - "style": "flat" - }, - "toolbar": { - "buttons": [ - { - "label": "QMK Firmware", - "icon": "fa fa-github", - "url": "https://github.com/qmk/qmk_firmware" - } - ] - }, - "bulk-redirect": { - "basepath": "/", - "redirectsFile": "docs/redirects.json" - } - }, - "root": "./docs/" -} 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. - -![Zadig mit Bo |