From 6dd790ba9481e5ec2141ef280c9b18b308bdafdc Mon Sep 17 00:00:00 2001 From: Nicolas Munnich <98408764+Nick-Munnich@users.noreply.github.com> Date: Wed, 21 Aug 2024 15:36:42 +0200 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Cem Aksoylar --- docs/docs/user-setup-cli.mdx | 16 +++++----------- docs/docs/user-setup.mdx | 2 +- 2 files changed, 6 insertions(+), 12 deletions(-) diff --git a/docs/docs/user-setup-cli.mdx b/docs/docs/user-setup-cli.mdx index 881557a1..ecb0dd23 100644 --- a/docs/docs/user-setup-cli.mdx +++ b/docs/docs/user-setup-cli.mdx @@ -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`.
I don't have Python 3.10 or newer installed. @@ -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 Enter, 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 diff --git a/docs/docs/user-setup.mdx b/docs/docs/user-setup.mdx index fb5f3dcb..006ed3d2 100644 --- a/docs/docs/user-setup.mdx +++ b/docs/docs/user-setup.mdx @@ -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