Skip to content

Commit 5ac6e20

Browse files
maralorndomenkozar
andauthored
Extend nix explanations in README (#549)
* Extend nix explanations in README * Correct ghcide-nix url Co-authored-by: Domen Kožar <[email protected]> Co-authored-by: Domen Kožar <[email protected]>
1 parent 5661348 commit 5ac6e20

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,17 @@ There are more details about our approach [in this blog post](https://4ta.uk/p/s
3131

3232
#### With Nix
3333

34-
[See ghcide-nix repository](https://github.com/hercules-ci/ghcide-nix)
34+
Note that you need to compile `ghcide` with the same `ghc` as the project you are working on.
35+
36+
1. If the `ghc` you are using matches the version (or better is) from `nixpkgs` it‘s easiest to use the `ghcide` from `nixpkgs`. You can do so via
37+
```
38+
nix-env -iA haskellPackages.ghcide
39+
```
40+
or e.g. including `pkgs.haskellPackages.ghcide` in your projects `shell.nix`.
41+
Depending on your `nixpkgs` channel that might not be the newest `ghcide`, though.
42+
43+
2. If your `ghc` does not match nixpkgs you should try the [ghcide-nix repository](https://github.com/cachix/ghcide-nix)
44+
which provides a `ghcide` via the `haskell.nix` infrastructure.
3545

3646
#### With Cabal or Stack
3747

0 commit comments

Comments
 (0)