You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
Copy file name to clipboardExpand all lines: README.md
+11-7Lines changed: 11 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,9 +14,11 @@ Install Git from https://git-scm.com/downloads.
14
14
15
15
If you have Windows 11, you can instead open a terminal and run:
16
16
17
+
```sh
18
+
winget install git.git -i
17
19
```
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.
20
22
21
23
## Install Python
22
24
@@ -226,7 +228,7 @@ Other commands use the following settings:
226
228
227
229
Command line for a text editor to use with the `zmk code` command.
228
230
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:
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:
254
260
255
261
```sh
256
262
pip install -e ".[dev]"
257
263
pre-commit install
258
264
```
259
265
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
-
262
266
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:
263
267
264
268
```sh
265
269
pyright .
266
270
pylint zmk
267
271
```
268
272
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