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

Apply suggestions from code review

Browse source 
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
This commit is contained in:
Nicolas Munnich 2024-08-21 15:36:42 +02:00 • committed by GitHub
parent 41e720b2b2
commit 6dd790ba94
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 6 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -17,12 +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
The below commands should print a version number if the program is installed.
```sh
git --version
```
@ -44,15 +42,13 @@ 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`
:::
ZMK CLI requires Python 3.10 or newer.
```sh
python3 --version
```
ZMK CLI requires Python 3.10 or newer.
Note that some operating systems may use `python` in place of `python3`.
<details>
<summary>I don't have Python 3.10 or newer installed.</summary>
@ -88,9 +84,7 @@ 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
@ -167,7 +161,7 @@ Otherwise, leave this first prompt blank and press <kbd>Enter</kbd>, and it will
Once you finish following all the instructions, you will have a copy of the repo stored on your computer. All `zmk` commands will run on this repo (unless the working directory is inside a different repo). If you ever forget where the repo is located, you can run `zmk cd` to find it.
Now that you have a repo created, see the instructions below for how ZMK CLI can automate some common tasks, or see [Customizing ZMK](customization.md) for more hands-on customisation information.
Now that you have a repo created, see the instructions below for how ZMK CLI can automate some common tasks, or see [Customizing ZMK](customization.md) for more hands-on customization information.
### Keyboard Management

2
docs/docs/user-setup.mdx
View file

@ -13,7 +13,7 @@ core ZMK Firmware source repository.
In addition to this, most users will not need to install any complicated toolchains or tools to build ZMK. GitHub Actions is used instead to automatically build the user's configured firmware for them.
:::info
ZMK currently has an **experimental** command line program set to replace the below steps. It is designed to automate a number of steps for you, and be easier to use. [Give it a try by following the instructions found here](user-setup-cli.mdx). Feedback and bug reports are very much welcome.
ZMK currently has an **experimental** command line program set to replace the below steps. It is designed to automate a number of steps for you and be easier to use. Give it a try by following the instructions found [here](user-setup-cli.mdx). Feedback and bug reports are very much welcome.
:::
## Summary