kb01/zmk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improvements from suggestions

Browse source
This commit is contained in:
Nicolas Munnich 2024-08-18 21:11:33 +02:00
parent 7a002998f5
commit 41e720b2b2
1 changed files with 12 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
docs/docs/user-setup-cli.mdx
View file

@ -17,6 +17,10 @@ If you use this program, any bug reports are highly appreciated. We are happy to
### Preliminaries
:::tip
The below commands should print a version number if the program is installed.
:::
#### Make sure you have Git installed
```sh
@ -40,8 +44,11 @@ Re-open your terminal and test to make sure it is now installed.
#### Make sure you have Python installed
:::tip
Some operating systems may use `python` in place of `python3`
:::
```sh
python --version
python3 --version
```
@ -81,6 +88,10 @@ Re-open your terminal and test to make sure it is now installed.
#### (Recommended) Make sure you have pipx installed
:::note
ZMK CLI can be installed with pip, but using [pipx](https://github.com/pypa/pipx) is recommended to avoid conflicts between Python packages.
:::
```sh
pipx --version
```
@ -88,8 +99,6 @@ pipx --version
<details>
<summary>I don't have pipx installed.</summary>
ZMK CLI can be installed with pip, but using [pipx](https://github.com/pypa/pipx) is recommended to avoid conflicts between Python packages.
### On Windows and Linux
Open a terminal and run: