You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+25-23Lines changed: 25 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,36 +26,38 @@ The following blog posts and talks provide some more in-depth educational materi
26
26
27
27
## Building
28
28
29
-
### Without nix
29
+
This package can be built using [Cabal](https://www.haskell.org/cabal/) and [GHC](https://www.haskell.org/ghc/).
30
30
31
-
This package uses [Cabal](https://www.haskell.org/cabal/)-based build. To build from source:
31
+
To build from source ensure both `ghc` and `cabal` executables are in your `PATH`:
32
32
33
-
* Ensure both `ghc` and `cabal` executables are in your `PATH`.
34
-
*[ghcup](https://www.haskell.org/ghcup/) is a great way to manage Haskell toolchain.
33
+
*[ghcup](https://www.haskell.org/ghcup/) is a great way to manage Haskell toolchains
34
+
*[With nix](#with-nix) explains how to use nix for this
35
35
* quickcheck-dynamic currently requires a GHC version > 8.10
36
-
* Run
37
-
```
38
-
cabal update && cabal build all
39
-
```
40
-
* To run tests:
41
-
```
42
-
cabal test all
43
-
```
36
+
37
+
Then run:
38
+
```
39
+
cabal update && cabal build all
40
+
```
41
+
42
+
To run all tests:
43
+
```
44
+
cabal test all
45
+
```
44
46
45
47
### With nix
46
48
47
49
This repository uses nix to provide a development and build environment.
48
50
49
51
For instructions on how to install and configure nix (including how to enable access to our binary caches), refer to [this document](https://github.com/input-output-hk/iogx/blob/main/doc/nix-setup-guide.md).
50
52
51
-
If you already have nix installed and configured, you may enter the development shell by running`nix develop`.
52
-
53
-
* To enter a shell providing a complete haskell toolchain:
54
-
```
55
-
nix develop
56
-
```
57
-
This can automated using [direnv](https://direnv.net/):
58
-
```
59
-
direnv allow
60
-
```
61
-
*Then go back to [Without nix](#without-nix) instructions
53
+
If you already have nix installed and configured, you may obtain a suitable development shell by running:
54
+
```
55
+
nix develop github:input-output-hk/devx#ghc96
56
+
```
57
+
58
+
You can also use [direnv](https://direnv.net/) to export the tools to your shell environment:
59
+
```
60
+
direnv allow
61
+
```
62
+
63
+
Then go back to [Without nix](#without-nix) instructions.
0 commit comments