Skip to content

Commit 1835994

Browse files
committed
Update the README
1 parent cc2f8fa commit 1835994

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

README.md

+12-10
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,24 @@ _(If you want to use this tool as a GitHub Workflow, check out [diff-package-api
55
Taken from the GHC CI scripts, this tool prints a human-readable representation of the exposed interface of Haskell modules that you
66
can use in CI to ensure that you do not mistakenly introduce a regression.
77

8-
The tool can be used with the following GHC versions:
8+
## Installation
99

10-
* 9.10.1
11-
* 9.8.2
12-
* 9.6.6
13-
14-
[Releases](https://github.com/Kleidukos/print-api/releases/latest) provide binaries for the following operating systems:
10+
Binaries for the following operating systems and GHC are provided:
1511

1612
* Linux x86_64 (glibc, dynamic)
1713
* Linux x86_64 (musl, static)
1814
* macOS arm64
1915

20-
Pick the one that matches your operating system *and* GHC version.
16+
* 9.10.1
17+
* 9.8.2
18+
* 9.6.6
19+
20+
### Releases
21+
22+
* [Pre-releases](https://github.com/Kleidukos/print-api/releases/tag/print-api-head) are provided if you need an urgent fix for a bug;
23+
* [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.
2124

22-
If you have the GitHub CLI installed, (something like) the following does work:
25+
If you have the [GitHub CLI](https://cli.github.com/) installed, (something like) the following does work:
2326

2427
```
2528
$ gh release download --repo Kleidukos/print-api --pattern "print-api-*-$(uname -s)-$(uname -m).tar.gz" --output - | tar -x -z -C <INSTALL_DIRECTORY>
@@ -44,8 +47,7 @@ $ cd print-api
4447
$ cabal install --with-compiler ghc-<GHC_VERSION>
4548
```
4649

47-
(There is also an `install-for-ghcup-compilers.sh` script in the `print-api`
48-
repository that installs `print-api` for GHCs currently installed by GHCup.)
50+
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.
4951

5052
Then run the `print-api` binary from within the source tree of your project:
5153

0 commit comments

Comments
 (0)