Skip to content

Commit b48e799

Browse files
committed
fix(docs): Improve installation documentation
Changed the instructions for installing Git with winget to use interactive mode so users can pick a default text editor. Also reworded the instructions for installing for development to suggest creating a virtual environment before the commands that should be run inside that environment. Addresses part of #23
1 parent ab33618 commit b48e799

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,11 @@ Install Git from https://git-scm.com/downloads.
1414

1515
If you have Windows 11, you can instead open a terminal and run:
1616

17+
```sh
18+
winget install git.git -i
1719
```
18-
winget install git.git
19-
```
20+
21+
The Windows installer will give you lots of options. You can leave all of them as their defaults, but when you get to the "choosing the default editor used by Git" screen, you may want to select a different text editor to use when writing Git commit messages.
2022

2123
## Install Python
2224

@@ -226,7 +228,7 @@ Other commands use the following settings:
226228

227229
Command line for a text editor to use with the `zmk code` command.
228230

229-
For example, so set Visual Studio Code as the editor and make it always open a new window, run:
231+
For example, to set Visual Studio Code as the editor and make it always open a new window, run:
230232

231233
```sh
232234
zmk config core.editor "code --new-window"
@@ -250,20 +252,22 @@ zmk config user.home ~/Documents/zmk-config
250252

251253
# Development
252254

253-
If you would like to help improve ZMK CLI, you can clone this repo and install it in editable mode so your changes to the code apply when you run `zmk`. Open a terminal to the root directory of the repository and run:
255+
If you would like to help improve ZMK CLI, you can clone this repo and install it in editable mode so your changes to the code apply when you run `zmk`. First, open a terminal to the root directory of the repository.
256+
257+
You may optionally run the following commands inside a [virtual environment](https://docs.python.org/3/library/venv.html) if you don't want to install ZMK CLI's dependencies globally or if your OS disallows doing this.
258+
259+
To install ZMK CLI in editable mode, run:
254260

255261
```sh
256262
pip install -e ".[dev]"
257263
pre-commit install
258264
```
259265

260-
You may optionally run these commands inside a [virtual environment](https://docs.python.org/3/library/venv.html) if you don't want to install ZMK CLI's dependencies globally or if your OS disallows doing this.
261-
262266
After running `pre-commit install`, your code will be checked when you make a commit, but there are some slower checks that do not run automatically. To run these additional checks, run these commands:
263267

264268
```sh
265269
pyright .
266270
pylint zmk
267271
```
268272

269-
Alternatively, you can just create a pull request and GitHub will run the checks and report any errors.
273+
GitHub will also run these checks and report any errors when you make a pull request.

0 commit comments

Comments
 (0)