Skip to content

Update readme for nix flake dev environment #3

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.

Sign up for GitHub

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

Draft
wants to merge 1 commit into
base: forketyfork/fix-compilation
Choose a base branch
from
Draft

Update readme for nix flake dev environment #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
39 changes: 38 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,44 @@ The repository is organized by chapters:
- `ch14/` - Zippers
- `ch15/` - Conclusion

## Running the Code
## Prerequisites

- Nix with flakes enabled. If flakes are not enabled on your system, you can use the one‑shot form:

```bash
nix --extra-experimental-features 'nix-command flakes' develop
```

## Quick start (Nix flakes)

Enter the development shell:

```bash
nix develop
```

Run examples inside the shell:

```bash
ghci ch1/baby.hs
ghc ch1/baby.hs && ./baby
```

Not using Nix? See Running the Code (without Nix) below.

## Formatting

Format Nix files via the flake formatter:

```bash
nix fmt
```

## Editor integration

Haskell Language Server works inside the `nix develop` shell. Optionally use `direnv` to auto‑enter the dev shell in your editor.

## Running the Code (without Nix)

You can compile and run individual Haskell files using GHC:

Expand Down