diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/cli_commands.md | 48 | ||||
| -rw-r--r-- | docs/contributing.md | 2 | ||||
| -rw-r--r-- | docs/de/cli.md | 19 | ||||
| -rw-r--r-- | docs/fr-fr/cli.md | 19 | ||||
| -rw-r--r-- | docs/hardware_keyboard_guidelines.md | 28 |
5 files changed, 29 insertions, 87 deletions
diff --git a/docs/cli_commands.md b/docs/cli_commands.md index 8fa7ad41d..06568afb4 100644 --- a/docs/cli_commands.md +++ b/docs/cli_commands.md | |||
| @@ -118,54 +118,6 @@ This command lets you configure the behavior of QMK. For the full `qmk config` d | |||
| 118 | qmk config [-ro] [config_token1] [config_token2] [...] [config_tokenN] | 118 | qmk config [-ro] [config_token1] [config_token2] [...] [config_tokenN] |
| 119 | ``` | 119 | ``` |
| 120 | 120 | ||
| 121 | ## `qmk console` | ||
| 122 | |||
| 123 | This command lets you connect to keyboard consoles to get debugging messages. It only works if your keyboard firmware has been compiled with `CONSOLE_ENABLE=yes`. | ||
| 124 | |||
| 125 | **Usage**: | ||
| 126 | |||
| 127 | ``` | ||
| 128 | qmk console [-d <pid>:<vid>[:<index>]] [-l] [-n] [-t] [-w <seconds>] | ||
| 129 | ``` | ||
| 130 | |||
| 131 | **Examples**: | ||
| 132 | |||
| 133 | Connect to all available keyboards and show their console messages: | ||
| 134 | |||
| 135 | ``` | ||
| 136 | qmk console | ||
| 137 | ``` | ||
| 138 | |||
| 139 | List all devices: | ||
| 140 | |||
| 141 | ``` | ||
| 142 | qmk console -l | ||
| 143 | ``` | ||
| 144 | |||
| 145 | Show only messages from clueboard/66/rev3 keyboards: | ||
| 146 | |||
| 147 | ``` | ||
| 148 | qmk console -d C1ED:2370 | ||
| 149 | ``` | ||
| 150 | |||
| 151 | Show only messages from the second clueboard/66/rev3: | ||
| 152 | |||
| 153 | ``` | ||
| 154 | qmk console -d C1ED:2370:2 | ||
| 155 | ``` | ||
| 156 | |||
| 157 | Show timestamps and VID:PID instead of names: | ||
| 158 | |||
| 159 | ``` | ||
| 160 | qmk console -n -t | ||
| 161 | ``` | ||
| 162 | |||
| 163 | Disable bootloader messages: | ||
| 164 | |||
| 165 | ``` | ||
| 166 | qmk console --no-bootloaders | ||
| 167 | ``` | ||
| 168 | |||
| 169 | ## `qmk doctor` | 121 | ## `qmk doctor` |
| 170 | 122 | ||
| 171 | This command examines your environment and alerts you to potential build or flash problems. It can fix many of them if you want it to. | 123 | This command examines your environment and alerts you to potential build or flash problems. It can fix many of them if you want it to. |
diff --git a/docs/contributing.md b/docs/contributing.md index 1d68d22d9..eb033d167 100644 --- a/docs/contributing.md +++ b/docs/contributing.md | |||
| @@ -105,7 +105,7 @@ enum my_keycodes { | |||
| 105 | 105 | ||
| 106 | Before opening a pull request, you can preview your changes if you have set up the development environment by running this command from the `qmk_firmware/` folder: | 106 | Before opening a pull request, you can preview your changes if you have set up the development environment by running this command from the `qmk_firmware/` folder: |
| 107 | 107 | ||
| 108 | ./bin/qmk docs | 108 | qmk docs |
| 109 | 109 | ||
| 110 | or if you only have Python 3 installed: | 110 | or if you only have Python 3 installed: |
| 111 | 111 | ||
diff --git a/docs/de/cli.md b/docs/de/cli.md index 7dc02d505..259aeecf7 100644 --- a/docs/de/cli.md +++ b/docs/de/cli.md | |||
| @@ -51,25 +51,6 @@ Wir suchen nach Freiwilligen, die ein `qmk`-Package für weitere Betriebssysteme | |||
| 51 | * Installiere mit einem [virtualenv](https://virtualenv.pypa.io/en/latest/). | 51 | * Installiere mit einem [virtualenv](https://virtualenv.pypa.io/en/latest/). |
| 52 | * Weise den User an, die Umgebungs-Variable `QMK_HOME` zu setzen, um die Firmware-Quelle anders einzustellen als `~/qmk_firmware`. | 52 | * Weise den User an, die Umgebungs-Variable `QMK_HOME` zu setzen, um die Firmware-Quelle anders einzustellen als `~/qmk_firmware`. |
| 53 | 53 | ||
| 54 | # Lokale CLI | ||
| 55 | |||
| 56 | Wenn Du die globale CLI nicht verwenden möchtest, beinhaltet `qmk_firmware` auch eine lokale CLI. Du kannst sie hier finden: `qmk_firmware/bin/qmk`. Du kannst den `qmk`-Befehl aus irgendeinem Datei-Verzeichnis ausführen und es wird immer auf dieser Kopie von `qmk_firmware` arbeiten. | ||
| 57 | |||
| 58 | **Beispiel**: | ||
| 59 | |||
| 60 | ``` | ||
| 61 | $ ~/qmk_firmware/bin/qmk hello | ||
| 62 | Ψ Hello, World! | ||
| 63 | ``` | ||
| 64 | |||
| 65 | ## Einschränkungen der lokalen CLI | ||
| 66 | |||
| 67 | Hier ein Vergleich mit der globalen CLI: | ||
| 68 | |||
| 69 | * Die lokale CLI unterstützt kein `qmk setup` oder `qmk clone`. | ||
| 70 | * Die lokale CLI arbeitet immer innerhalb der selben `qmk_firmware`-Verzeichnisstruktur, auch wenn Du mehrere Repositories geklont hast. | ||
| 71 | * Die lokale CLI läuft nicht in einer virtualenv. Daher ist es möglich, dass Abhängigkeiten (dependencies) miteinander in Konflikt kommen/stehen. | ||
| 72 | |||
| 73 | # CLI-Befehle | 54 | # CLI-Befehle |
| 74 | 55 | ||
| 75 | ## `qmk compile` | 56 | ## `qmk compile` |
diff --git a/docs/fr-fr/cli.md b/docs/fr-fr/cli.md index bfa060f2a..917a9315b 100644 --- a/docs/fr-fr/cli.md +++ b/docs/fr-fr/cli.md | |||
| @@ -48,25 +48,6 @@ Nous recherchons des gens pour créer et maintenir un paquet `qmk` pour plus de | |||
| 48 | * Installez en utilisant un virtualenv | 48 | * Installez en utilisant un virtualenv |
| 49 | * Expliquez à l'utilisateur de définir la variable d'environnement `QMK_Home` pour "check out" les sources du firmware à un autre endroit que `~/qmk_firmware`. | 49 | * Expliquez à l'utilisateur de définir la variable d'environnement `QMK_Home` pour "check out" les sources du firmware à un autre endroit que `~/qmk_firmware`. |
| 50 | 50 | ||
| 51 | # CLI locale | ||
| 52 | |||
| 53 | Si vous ne voulez pas utiliser la CLI globale, il y a une CLI locale empaquetée avec `qmk_firmware`. Vous pouvez le trouver dans `qmk_firmware/bin/qmk`. Vous pouvez lancer la commande `qmk` depuis n'importe quel répertoire et elle fonctionnera toujours sur cette copie de `qmk_firmware`. | ||
| 54 | |||
| 55 | **Exemple**: | ||
| 56 | |||
| 57 | ``` | ||
| 58 | $ ~/qmk_firmware/bin/qmk hello | ||
| 59 | Ψ Hello, World! | ||
| 60 | ``` | ||
| 61 | |||
| 62 | ## Limitations de la CLI locale | ||
| 63 | |||
| 64 | Il y a quelques limitations à la CLI locale comparé à la globale: | ||
| 65 | |||
| 66 | * La CLI locale ne supporte pas `qmk setup` ou `qmk clone` | ||
| 67 | * La CLI locale n'opère pas sur le même arbre `qmk_firmware`, même si vous avez plusieurs dépôts clonés. | ||
| 68 | * La CLI locale ne s'exécute pas dans un virtualenv, donc il y a des risques que des dépendances seront en conflit | ||
| 69 | |||
| 70 | # Les commandes CLI | 51 | # Les commandes CLI |
| 71 | 52 | ||
| 72 | ## `qmk compile` | 53 | ## `qmk compile` |
diff --git a/docs/hardware_keyboard_guidelines.md b/docs/hardware_keyboard_guidelines.md index 7630b44e0..17be7ee6a 100644 --- a/docs/hardware_keyboard_guidelines.md +++ b/docs/hardware_keyboard_guidelines.md | |||
| @@ -144,10 +144,38 @@ The `rules.mk` file can also be placed in a sub-folder, and its reading order is | |||
| 144 | * `keyboards/top_folder/sub_1/sub_2/sub_3/sub_4/rules.mk` | 144 | * `keyboards/top_folder/sub_1/sub_2/sub_3/sub_4/rules.mk` |
| 145 | * `keyboards/top_folder/keymaps/a_keymap/rules.mk` | 145 | * `keyboards/top_folder/keymaps/a_keymap/rules.mk` |
| 146 | * `users/a_user_folder/rules.mk` | 146 | * `users/a_user_folder/rules.mk` |
| 147 | * `keyboards/top_folder/sub_1/sub_2/sub_3/sub_4/post_rules.mk` | ||
| 148 | * `keyboards/top_folder/sub_1/sub_2/sub_3/post_rules.mk` | ||
| 149 | * `keyboards/top_folder/sub_1/sub_2/post_rules.mk` | ||
| 150 | * `keyboards/top_folder/sub_1/post_rules.mk` | ||
| 151 | * `keyboards/top_folder/post_rules.mk` | ||
| 147 | * `common_features.mk` | 152 | * `common_features.mk` |
| 148 | 153 | ||
| 149 | Many of the settings written in the `rules.mk` file are interpreted by `common_features.mk`, which sets the necessary source files and compiler options. | 154 | Many of the settings written in the `rules.mk` file are interpreted by `common_features.mk`, which sets the necessary source files and compiler options. |
| 150 | 155 | ||
| 156 | The `post_rules.mk` file can interpret `features` of a keyboard-level before `common_features.mk`. For example, when your designed keyboard has the option to implement backlighting or underglow using rgblight.c, writing the following in the `post_rules.mk` makes it easier for the user to configure the `rules.mk`. | ||
| 157 | |||
| 158 | * `keyboards/top_folder/keymaps/a_keymap/rules.mk` | ||
| 159 | ```makefile | ||
| 160 | # Please set the following according to the selection of the hardware implementation option. | ||
| 161 | RGBLED_OPTION_TYPE = backlight ## none, backlight or underglow | ||
| 162 | ``` | ||
| 163 | * `keyboards/top_folder/post_rules.mk` | ||
| 164 | ```makefile | ||
| 165 | ifeq ($(filter $(strip $(RGBLED_OPTION_TYPE))x, nonex backlightx underglowx x),) | ||
| 166 | $(error unknown RGBLED_OPTION_TYPE value "$(RGBLED_OPTION_TYPE)") | ||
| 167 | endif | ||
| 168 | |||
| 169 | ifeq ($(strip $(RGBLED_OPTION_TYPE)),backlight) | ||
| 170 | RGBLIGHT_ENABLE = yes | ||
| 171 | OPT_DEFS += -DRGBLED_NUM=30 | ||
| 172 | endif | ||
| 173 | ifeq ($(strip $(RGBLED_OPTION_TYPE)),underglow) | ||
| 174 | RGBLIGHT_ENABLE = yes | ||
| 175 | OPT_DEFS += -DRGBLED_NUM=6 | ||
| 176 | endif | ||
| 177 | ``` | ||
| 178 | |||
| 151 | ?> See `build_keyboard.mk` and `common_features.mk` for more details. | 179 | ?> See `build_keyboard.mk` and `common_features.mk` for more details. |
| 152 | 180 | ||
| 153 | ### `<keyboard_name.c>` | 181 | ### `<keyboard_name.c>` |
