Skip to content

Update nix documentation the README #61

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 10, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Update nix documentation the README
  • Loading branch information
zeme-wana committed Nov 8, 2023
commit 1097c9e1437ec6e5d767af429aa967de1a5a6d0e
17 changes: 11 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,13 +47,18 @@ 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.

If you know nix, simply run `nix develop` to enter the shell; if prompted, trust
the flake config values to enable access to our binary caches.

The nix code is based on a template from the
[IOGX flake](https://github.com/input-output-hk/iogx).
For instructions on how to install and configure nix (including how to enable
access to our binary caches), and how keep the flake inputs up to date, refer to
[this section](https://github.com/input-output-hk/iogx/blob/main/doc/api.md#flakenix)
of the IOGX manual.

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