Skip to content

Commit

Permalink
Merge pull request #4688 from IntersectMBO/4687-main-readme-should-sa…
Browse files Browse the repository at this point in the history
…y-how-to-enter-nix-shell

Add `nix develop` to main `README.md`
  • Loading branch information
teodanciu authored Oct 16, 2024
2 parents b2dc785 + f7689d3 commit b1c55e1
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,10 +86,9 @@ The directory structure of this repository is as follows:

# Building

It is recommended to use [`nix`](https://nixos.org/nix/download.html) for building everything in this repository.
Haskell files can be built with [`cabal`](https://www.haskell.org/cabal/) inside of a nix shell.
It is recommended to use [`nix`](https://nixos.org/nix/download.html) for building everything in this repository. Make sure you have a recent version of `nix` by following this [guide](https://nixos.org/manual/nix/stable/installation/upgrading.html).

Make sure you have a recent version of `nix` by following this [guide](https://nixos.org/manual/nix/stable/installation/upgrading.html)
Haskell files can be built with [`cabal`](https://www.haskell.org/cabal/) inside of a nix shell, which can be entered by invoking `nix develop` from the root directory.

## Nix Cache

Expand Down Expand Up @@ -164,7 +163,7 @@ nix develop --command make watch

# Testing

Run `cabal test all` to run all tests or `cabal test <package>` to run the tests for a specific package.
From the root directory invoke `nix develop` to enter a nix shell, then run `cabal test all` to run all tests or `cabal test <package>` to run the tests for a specific package.

Note: The `CARDANO_MAINNET_MIRROR` environment variable can be overridden in `flake.nix` if one desires to run
the Byron tests with a different version of the [mainnet epochs](https://github.com/input-output-hk/cardano-mainnet-mirror/tree/master/epochs).
Expand Down

0 comments on commit b1c55e1

Please sign in to comment.