Skip to content

Commit cd1bf7c

Browse files
committed
Improve install instructions
1 parent aa26a78 commit cd1bf7c

File tree

3 files changed

+18
-12
lines changed

3 files changed

+18
-12
lines changed

.github/install_darwin.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,14 @@ In order to install the downloaded klog binary on your system, follow these step
66
- Either right-click on the binary in the Finder, and select “Open“
77
- Or remove the “quarantine” flag from the binary via the CLI:
88
`xattr -d com.apple.quarantine klog`
9-
2. Copy it to a location that’s covered by your `$PATH` environment variabke, e.g.
9+
2. Copy the executable to a location that’s included in your `$PATH` environment variable, e.g.
1010
`mv klog /usr/local/bin/klog` (might require `sudo`)
1111

12+
For other install options, see [the documentation website](https://klog.jotaen.net/#get-klog).
13+
14+
## Check for updates
15+
1216
In order to not miss any updates you can either subscribe to the release
1317
notifications on [Github](https://github.com/jotaen/klog) (at the top right:
14-
“Watch”“Custom”“Releases”), or you occasionally check by running
18+
“Watch”“Custom”“Releases”), or you occasionally check by running
1519
`klog version`.
16-
17-
For other install options, see [the documentation website](https://klog.jotaen.net/#get-klog).

.github/install_linux.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
# Install klog
22

33
In order to install the downloaded klog binary on your system, copy it
4-
to a location that’s covered by your `$PATH` environment variable, e.g.
4+
to a location that’s included in your `$PATH` environment variable, e.g.
55
`mv klog /usr/local/bin/klog` (might require `sudo`).
66

7+
For other install options, see [the documentation website](https://klog.jotaen.net/#get-klog).
8+
9+
## Check for updates
10+
711
In order to not miss any updates you can either subscribe to the release
812
notifications on [Github](https://github.com/jotaen/klog) (at the top right:
9-
“Watch”“Custom”“Releases”), or you occasionally check by running
13+
“Watch”“Custom”“Releases”), or you occasionally check by running
1014
`klog version`.
11-
12-
For other install options, see [the documentation website](https://klog.jotaen.net/#get-klog).

.github/install_windows.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
# Install klog
22

33
In order to install the downloaded klog binary on your system, copy it
4-
to a location that’s covered by your `PATH` environment variable, e.g.
4+
to a location that’s included in your `PATH` environment variable, e.g.
55
`C:\Windows\System32` (might require admin privileges).
66

7+
For other install options, see [the documentation website](https://klog.jotaen.net/#get-klog).
8+
9+
## Check for updates
10+
711
In order to not miss any updates you can either subscribe to the release
812
notifications on [Github](https://github.com/jotaen/klog) (at the top right:
9-
“Watch”“Custom”“Releases”), or you occasionally check by running
13+
“Watch”“Custom”“Releases”), or you occasionally check by running
1014
`klog version`.
11-
12-
For other install options, see [the documentation website](https://klog.jotaen.net/#get-klog).

0 commit comments

Comments
 (0)