From bdaf25af95abe78278bb468e5d7b5ba1d1880263 Mon Sep 17 00:00:00 2001 From: aurc <54873456+aurc@users.noreply.github.com> Date: Sat, 13 Aug 2022 13:03:18 +1000 Subject: [PATCH] Finalised documentation for full windows support. --- .goreleaser.yaml | 6 +++--- README.md | 15 +++++++++++++-- 2 files changed, 16 insertions(+), 5 deletions(-) diff --git a/.goreleaser.yaml b/.goreleaser.yaml index 101796d..7cae84f 100644 --- a/.goreleaser.yaml +++ b/.goreleaser.yaml @@ -11,7 +11,7 @@ builds: - arm64 nfpms: - maintainer: Aurelio Calegari (aurcbot@gmail.com) - description: Rich Terminal User Interface streaming JSON logs + description: Rich Terminal User Interface streaming structured logs homepage: https://github.com/aurc/loggo license: MIT formats: @@ -52,11 +52,11 @@ brews: # Your app's homepage. # Default is empty. - homepage: "https://github.com/aurc/homebrew-loggo" + homepage: "https://github.com/aurc/loggo" # Template of your app's description. # Default is empty. - description: "Rich Terminal User Interface for JSON logs" + description: "Rich Terminal User Interface for streaming structured logs" # SPDX identifier of your app's license. # Default is empty. diff --git a/README.md b/README.md index 1503091..c755bfd 100644 --- a/README.md +++ b/README.md @@ -80,8 +80,19 @@ for the following platforms: Latest Release [pre-build binaries here](https://github.com/aurc/loggo/releases/latest)! -- Windows 11 plat (e.g. loggo_vx.y.z_linux_.tar.gz): -- Linux (both arm64 and amd64 plat): +- **Windows 11**: + + Download a `tar.gz` file from [pre-build binaries](https://github.com/aurc/loggo/releases/latest) that match your platform: + - Most of PCs will be `amd64`, so file format will be like `loggo_x.y.z_windows_amd64.tar.gz`. Note: *If you own a Surface Pro, or +virtualised windows on a Mac M series, you'll probably want to grab the `arm64` version.* + - Open a terminal window (`cmd.exe`) and issue the following command in the folder you downloaded the file: + ```` + tar -xvzf loggo_x.y.z_windows_amd64.tar.gz + ```` + - A file `loggo.exe` will be extracted to the current folder. + - You can place this file in a directory that's on your %PATH% so the command `loggo` is accessible from anywhere. + - +- **Linux** (both arm64 and amd64 plat): - ubuntu: `tar.gz` file from releases (e.g. loggo_vx.y.z_linux_.tar.gz) - debian: `*.deb` file from releases - redhat: `*.rpm` file from releases