fdcea06336
PR #13296 changed the name of the `cformat` and `pyformat` commands to `format-c` and `format-py` respectively. This PR updates the documentation and some parts of the CLI to use the new names. Also add documentation for the new `format-text` subcommand, introduced in the same PR. |
||
|---|---|---|
| .. | ||
| README.md | ||
| _summary.md | ||
| cli.md | ||
| driver_installation_zadig.md | ||
| newbs.md | ||
| newbs_building_firmware.md | ||
| newbs_flashing.md | ||
| newbs_getting_started.md | ||
| newbs_learn_more_resources.md | ||
| newbs_testing_debugging.md | ||
README.md
Quantum Mechanical Keyboard Firmware
Was ist QMK Firmware?
QMK (Quantum Mechanical Keyboard) ist eine Open-Source-Community, welche die QMK-Firmware, die QMK-Toolbox, qmk.fm und diese Dokumententation betreut. QMK-Firmware ist eine Weiterentwicklung der tmk_keyboard-Tastatur-Firmware mit vielen nützlichen Zusatzfunktionen für Atmel AVR-Prozessoren. Ursprünglich wurde sie für Produkte von OLKB, das ErgoDox EZ und das Clueboard entwickelt. Im Laufe der Zeit wurde sie mit Hilfe von ChibiOS 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 forkst, die Änderungen in deinem lokalen Repo vornimmst und anschließend einen Pull Request einreichst.
Ansonsten kannst Du es als zip oder tar 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 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, die es zu entdecken gibt. In der Dokumentation kannst Du Dir einen Überblick verschaffen. Die meisten Features basieren darauf, die Tastaturbelegung anzupassen und das Verhalten der Keycodes zu verändern.