From cd1bf7c64b1d9dd78095720b32ffbcea5a05c685 Mon Sep 17 00:00:00 2001 From: Jan Heuermann Date: Mon, 1 May 2023 11:58:10 +0200 Subject: [PATCH] Improve install instructions --- .github/install_darwin.md | 10 ++++++---- .github/install_linux.md | 10 ++++++---- .github/install_windows.md | 10 ++++++---- 3 files changed, 18 insertions(+), 12 deletions(-) diff --git a/.github/install_darwin.md b/.github/install_darwin.md index be587b4..62482e6 100644 --- a/.github/install_darwin.md +++ b/.github/install_darwin.md @@ -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). diff --git a/.github/install_linux.md b/.github/install_linux.md index c877806..7c55f57 100644 --- a/.github/install_linux.md +++ b/.github/install_linux.md @@ -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). diff --git a/.github/install_windows.md b/.github/install_windows.md index c5530b2..695c7f8 100644 --- a/.github/install_windows.md +++ b/.github/install_windows.md @@ -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).