From d737d711bb1a8db07c64e1580c14323d7c7f81a8 Mon Sep 17 00:00:00 2001 From: Yvan Sraka Date: Fri, 1 Sep 2023 10:08:13 +0200 Subject: [PATCH] Add Nix developer shell instructions to CONTRIBUTING.md --- CONTRIBUTING.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9ba09634a15..eb2700d377a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,6 +15,13 @@ If not, you aren't able to build the testsuite, so you need to disable the defau cabal build --project-file=cabal.project.release cabal ``` +> **Note** +> If you're using Nix, you might find it convenient to work within a shell that has all the `Cabal` development dependencies: +> ``` +> $ nix-shell -p cabal-install ghc ghcid haskellPackages.fourmolu_0_12_0_0 pkgconfig zlib.dev +> ``` +> A Nix flake developer shell with these dependencies is also available, supported solely by the community, through the command `nix develop github:yvan-sraka/cabal.nix`. + The location of your build products will vary depending on which version of cabal-install you use to build; see the documentation section [Where are my build products?](http://cabal.readthedocs.io/en/latest/nix-local-build.html#where-are-my-build-products)