Skip to content

Commit

Permalink
Update nix documentation the README (#61)
Browse files Browse the repository at this point in the history
  • Loading branch information
zeme-wana authored Nov 10, 2023
1 parent d1d1334 commit f72463b
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 10 deletions.
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,13 +47,12 @@ This package uses [Cabal](https://www.haskell.org/cabal/)-based build. To build

### With nix

This repository comes with some [nix](https://nixos.org) files which might or might not help hacking on quickcheck-dynamic simpler.
Before you start using nix, please make sure you've configured haskell.nix caching as per [those instructions](https://input-output-hk.github.io/haskell.nix/tutorials/getting-started.html#setting-up-the-binary-cache).
This repository uses nix to provide a development and build environment.

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).

If you already have nix installed and configured, you may enter the development shell by running `nix develop`.

* Building with nix should be as simple as:
```
nix build .#quickcheck-dynamic-lib-quickcheck-dynamic-ghc927
```
* To enter a shell providing a complete haskell toolchain:
```
nix develop
Expand Down
25 changes: 21 additions & 4 deletions flake.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit f72463b

Please sign in to comment.