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

Commit 91c2b2b

Browse files
author
Patrick Thomson
authored
Merge branch 'master' into please-dont-just-review-our-PRs
2 parents fd2ba55 + 0d2452f commit 91c2b2b

File tree

2 files changed

+8
-3
lines changed

2 files changed

+8
-3
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -96,19 +96,20 @@ 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 GHC packages installed through your OS's package manager 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
102104
git clone git@github.com:github/semantic.git
103105
cd semantic
104-
git submodule sync --recursive && git submodule update --init --recursive --force
105-
cabal new-update
106+
script/bootstrap
106107
cabal new-build
107108
cabal new-test
108109
cabal new-run semantic -- --help
109110
```
110111

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.
112+
`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.
112113

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

script/bootstrap

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
#!/bin/bash
2+
3+
git submodule sync --recursive && git submodule update --init --recursive --force
4+
cabal new-update

0 commit comments

Comments
 (0)