From f72463bdd682e40334b20a7d7dcb7bc3b6650485 Mon Sep 17 00:00:00 2001 From: zeme-wana <15709674+zeme-wana@users.noreply.github.com> Date: Fri, 10 Nov 2023 18:20:49 +0100 Subject: [PATCH] Update nix documentation the README (#61) --- README.md | 11 +++++------ flake.lock | 25 +++++++++++++++++++++---- 2 files changed, 26 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index c9ac3c9..5e9ae00 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/flake.lock b/flake.lock index 31339d7..5d52728 100644 --- a/flake.lock +++ b/flake.lock @@ -505,15 +505,16 @@ "nixpkgs": [ "nixpkgs" ], + "nixpkgs-stable": "nixpkgs-stable", "pre-commit-hooks-nix": "pre-commit-hooks-nix", "sphinxcontrib-haddock": "sphinxcontrib-haddock" }, "locked": { - "lastModified": 1698052499, - "narHash": "sha256-FoXYUaknObBfNoYaWt06Aq4pV+QvI0h1EXdzK4yutEg=", + "lastModified": 1699537966, + "narHash": "sha256-MGGza+vZDRjKj31WhQJDt7CqVVdrFkgkXIcqr0gDiU8=", "owner": "input-output-hk", "repo": "iogx", - "rev": "98685364d646db5e7cb64bcbe9d455e8f2bb99d7", + "rev": "c6ce7f034717ed0c0e9c6dd8fa2f898a15439627", "type": "github" }, "original": { @@ -729,6 +730,22 @@ } }, "nixpkgs-stable": { + "locked": { + "lastModified": 1690680713, + "narHash": "sha256-NXCWA8N+GfSQyoN7ZNiOgq/nDJKOp5/BHEpiZP8sUZw=", + "owner": "NixOS", + "repo": "nixpkgs", + "rev": "b81af66deb21f73a70c67e5ea189568af53b1e8c", + "type": "github" + }, + "original": { + "owner": "NixOS", + "repo": "nixpkgs", + "rev": "b81af66deb21f73a70c67e5ea189568af53b1e8c", + "type": "github" + } + }, + "nixpkgs-stable_2": { "locked": { "lastModified": 1685801374, "narHash": "sha256-otaSUoFEMM+LjBI1XL/xGB5ao6IwnZOXc47qhIgJe8U=", @@ -799,7 +816,7 @@ "flake-utils": "flake-utils_3", "gitignore": "gitignore", "nixpkgs": "nixpkgs_2", - "nixpkgs-stable": "nixpkgs-stable" + "nixpkgs-stable": "nixpkgs-stable_2" }, "locked": { "lastModified": 1696846637,