Skip to content

Commit

Permalink
Improve install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
jotaen committed May 1, 2023
1 parent aa26a78 commit cd1bf7c
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 12 deletions.
10 changes: 6 additions & 4 deletions .github/install_darwin.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,14 @@ In order to install the downloaded klog binary on your system, follow these step
- Either right-click on the binary in the Finder, and select “Open“
- Or remove the “quarantine” flag from the binary via the CLI:
`xattr -d com.apple.quarantine klog`
2. Copy it to a location that’s covered by your `$PATH` environment variabke, e.g.
2. Copy the executable to a location that’s included in your `$PATH` environment variable, e.g.
`mv klog /usr/local/bin/klog` (might require `sudo`)

For other install options, see [the documentation website](https://klog.jotaen.net/#get-klog).

## Check for updates

In order to not miss any updates you can either subscribe to the release
notifications on [Github](https://github.com/jotaen/klog) (at the top right:
“Watch”“Custom”“Releases”), or you occasionally check by running
“Watch”“Custom”“Releases”), or you occasionally check by running
`klog version`.

For other install options, see [the documentation website](https://klog.jotaen.net/#get-klog).
10 changes: 6 additions & 4 deletions .github/install_linux.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
# Install klog

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

For other install options, see [the documentation website](https://klog.jotaen.net/#get-klog).

## Check for updates

In order to not miss any updates you can either subscribe to the release
notifications on [Github](https://github.com/jotaen/klog) (at the top right:
“Watch”“Custom”“Releases”), or you occasionally check by running
“Watch”“Custom”“Releases”), or you occasionally check by running
`klog version`.

For other install options, see [the documentation website](https://klog.jotaen.net/#get-klog).
10 changes: 6 additions & 4 deletions .github/install_windows.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
# Install klog

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

For other install options, see [the documentation website](https://klog.jotaen.net/#get-klog).

## Check for updates

In order to not miss any updates you can either subscribe to the release
notifications on [Github](https://github.com/jotaen/klog) (at the top right:
“Watch”“Custom”“Releases”), or you occasionally check by running
“Watch”“Custom”“Releases”), or you occasionally check by running
`klog version`.

For other install options, see [the documentation website](https://klog.jotaen.net/#get-klog).

0 comments on commit cd1bf7c

Please sign in to comment.