aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorZach White <skullydazed@gmail.com>2021-08-29 16:50:22 -0700
committerGitHub <noreply@github.com>2021-08-29 16:50:22 -0700
commit596c4a1f87b46e1858c7d3630802eec741d1cc28 (patch)
tree4985aa763eca968615ae7b8004261fa76262a389 /docs
parentb46064a891332db07643f73018910c031a63aa50 (diff)
downloadqmk_firmware-596c4a1f87b46e1858c7d3630802eec741d1cc28.tar.gz
qmk_firmware-596c4a1f87b46e1858c7d3630802eec741d1cc28.zip
Remove bin/qmk (#14231)
* Remove the bin/qmk script * remove bin/qmk from workflows
Diffstat (limited to 'docs')
-rw-r--r--docs/contributing.md2
-rw-r--r--docs/de/cli.md19
-rw-r--r--docs/fr-fr/cli.md19
3 files changed, 1 insertions, 39 deletions
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
106Before 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: 106Before 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
110or if you only have Python 3 installed: 110or 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
56Wenn 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
67Hier 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
53Si 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
64Il 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`