From 3f876ac2bdaeac3a9502c3f9d7338c117f3647ee Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=C3=A9cate=20Kleidukos?= Date: Sun, 1 Sep 2024 19:41:08 +0200 Subject: [PATCH] Update the README --- README.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 017658b..f57c1be 100644 --- a/README.md +++ b/README.md @@ -5,21 +5,24 @@ _(If you want to use this tool as a GitHub Workflow, check out [diff-package-api Taken from the GHC CI scripts, this tool prints a human-readable representation of the exposed interface of Haskell modules that you can use in CI to ensure that you do not mistakenly introduce a regression. -The tool can be used with the following GHC versions: +## Installation -* 9.10.1 -* 9.8.2 -* 9.6.6 - -[Releases](https://github.com/Kleidukos/print-api/releases/latest) provide binaries for the following operating systems: +Binaries for the following operating systems are provided: * Linux x86_64 (glibc, dynamic) * Linux x86_64 (musl, static) * macOS arm64 -Pick the one that matches your operating system *and* GHC version. +`print-api` can be used with the following GHC versions: + +* 9.10.1 +* 9.8.2 +* 9.6.6 + +* [Pre-releases](https://github.com/Kleidukos/print-api/releases/tag/print-api-head) are provided if you need an urgent fix for a bug; +* [Official releases](https://github.com/Kleidukos/print-api/releases/latest) are available if you need stability and you don't urgently require the latest features. -If you have the GitHub CLI installed, (something like) the following does work: +If you have the [GitHub CLI](https://cli.github.com/) installed, (something like) the following does work: ``` $ gh release download --repo Kleidukos/print-api --pattern "print-api-*-$(uname -s)-$(uname -m).tar.gz" --output - | tar -x -z -C @@ -44,8 +47,7 @@ $ cd print-api $ cabal install --with-compiler ghc- ``` -(There is also an `install-for-ghcup-compilers.sh` script in the `print-api` -repository that installs `print-api` for GHCs currently installed by GHCup.) +There is also an `install-for-ghcup-compilers.sh` script in the `print-api` repository that installs `print-api` for GHCs currently installed by GHCup. Then run the `print-api` binary from within the source tree of your project: