diff --git a/docs/docs/user-setup-cli.mdx b/docs/docs/user-setup-cli.mdx index 2c92c790..881557a1 100644 --- a/docs/docs/user-setup-cli.mdx +++ b/docs/docs/user-setup-cli.mdx @@ -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
I don't have pipx installed. -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: