Skip to content

Commit af961c8

Browse files
committed
doc: update contributing commands
1 parent 8e35245 commit af961c8

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,25 @@ Contributions are very welcome! To hack on the github version, clone the
44
repository. You can use `cabal`:
55

66
```shell
7-
./scripts/start-sandbox.sh # Initialize the sandbox and add-source the packages
8-
./scripts/test-all.sh # Run all the tests
7+
cabal build all # Install dependencies and build packages
8+
cabal test all # Run all the tests
99
```
1010

1111
Or `stack`:
1212

1313
```shell
14-
stack setup # Downloads and installs a proper GHC version if necessary
15-
stack build --fast --pedantic # Install dependencies and build packages
16-
stack test # Run all the tests
14+
stack setup # Downloads and installs a proper GHC version if necessary
15+
stack build --fast # Install dependencies and build packages
16+
stack test # Run all the tests
1717
```
1818

1919
Or `nix`:
20+
2021
```shell
21-
./scripts/generate-nix-files.sh # Get up-to-date shell.nix files
22+
nix-shell nix/shell.nix # Enter a new development shell with Cabal and Stack
23+
24+
# Alternatively, another version of GHC can be used. See nix/README.md for more info.
25+
nix-shell nix/shell.nix --argstr compiler ghc901
2226
```
2327

2428
To build the docs, see `doc/README.md`.

0 commit comments

Comments
 (0)