From 7f77ab6e123f82e36fe2e99c616beadf86911065 Mon Sep 17 00:00:00 2001 From: Patrick Thomson Date: Mon, 17 Jun 2019 13:34:36 -0400 Subject: [PATCH 1/2] 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. --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2798765789..c5da95dd70 100644 --- a/README.md +++ b/README.md @@ -96,6 +96,8 @@ Available options: ## Development +`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. + We use `cabal's` [Nix-style local builds][nix] for development. To get started quickly: ```bash @@ -108,7 +110,7 @@ cabal new-test cabal new-run semantic -- --help ``` -`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. + `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. [nix]: https://www.haskell.org/cabal/users-guide/nix-local-build-overview.html [stackage]: https://stackage.org From 992c84c03135e2356a17f5e7b9f2c32b5044f4ec Mon Sep 17 00:00:00 2001 From: Patrick Thomson Date: Mon, 17 Jun 2019 13:52:00 -0400 Subject: [PATCH 2/2] better language --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c5da95dd70..399bd176ea 100644 --- a/README.md +++ b/README.md @@ -96,7 +96,7 @@ Available options: ## Development -`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. +`semantic` requires at least GHC 8.6.4 and Cabal 2.4. We strongly recommend using [`ghcup`][ghcup] to sandbox GHC versions, as GHC packages installed through your OS's package manager may not install statically-linked versions of the GHC boot libraries. We use `cabal's` [Nix-style local builds][nix] for development. To get started quickly: