Skip to content
This repository was archived by the owner on Apr 1, 2025. It is now read-only.

Commit 7f77ab6

Browse files
author
Patrick Thomson
committed
Emphasize ghcup and discourage use of system GHCs.
In #109, we encountered Arch users whose build failed because Arch installs a GHC configured to use dynamic linking by default, and GHC is relatively reluctant to use dynamic linking (and sensibly, too, given that ABIs vary between releases of GHC). Though Arch users should be able to work around this problem with careful use of `new-configure` flags, I submit that we should strongly encourage people to use sandboxed, statically-linked GHCs, rather than contort our code to account for questionable decisions on the part of the OS.
1 parent 23df12a commit 7f77ab6

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,8 @@ Available options:
9696

9797
## Development
9898

99+
`semantic` requires at least GHC 8.6.4 and Cabal 2.4. We strongly recommend using [`ghcup`][ghcup] to sandbox GHC versions, as system packages installed from OS distributions may not install statically-linked versions of the GHC boot libraries.
100+
99101
We use `cabal's` [Nix-style local builds][nix] for development. To get started quickly:
100102

101103
```bash
@@ -108,7 +110,7 @@ cabal new-test
108110
cabal new-run semantic -- --help
109111
```
110112

111-
`semantic` requires at least GHC 8.6.4 and Cabal 2.4. We recommend using [`ghcup`][ghcup] to sandbox GHC versions. `stack` as a build tool is not officially supported; there is an unofficial [`stack.yaml`](https://gist.github.com/jkachmar/f200caee83280f1f25e9cfa2dd2b16bb) available, though we cannot make guarantees as to its stability.
113+
`stack` as a build tool is not officially supported; there is an unofficial [`stack.yaml`](https://gist.github.com/jkachmar/f200caee83280f1f25e9cfa2dd2b16bb) available, though we cannot make guarantees as to its stability.
112114

113115
[nix]: https://www.haskell.org/cabal/users-guide/nix-local-build-overview.html
114116
[stackage]: https://stackage.org

0 commit comments

Comments
 (0)