Skip to content

Commit 853c62d

Browse files
committed
docs(readme): improve Nix development environment setup instructions
- Add Nix installation command using experimental installer - Add instructions for enabling flakes if not already enabled - Clarify direnv activation (use existing .envrc) - Link to flake.nix for reference
1 parent d32fe37 commit 853c62d

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

README.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -600,13 +600,27 @@ The tool description includes clear instructions for AI agents to always ask for
600600

601601
### Using Nix Flake
602602

603-
This project includes a Nix flake for reproducible development environments. If you have Nix installed with flakes enabled, you can use it to set up your development environment:
603+
This project includes a Nix flake for reproducible development environments. All development tools are defined in [flake.nix](./flake.nix) and provided via Nix.
604+
605+
#### Installing Nix
604606

605607
```bash
606-
# Enter development shell
607-
nix develop
608+
# Install Nix with flakes enabled (if not already installed)
609+
curl --proto '=https' --tlsv1.2 -sSf -L https://artifacts.nixos.org/experimental-installer | \
610+
sh -s -- install
611+
612+
# If flakes are not enabled, enable them with:
613+
mkdir -p ~/.config/nix && echo "experimental-features = nix-command flakes" >> ~/.config/nix/nix.conf
614+
```
608615

616+
#### Activating the Development Environment
617+
618+
```bash
619+
# Automatic activation with direnv (recommended)
609620
direnv allow
621+
622+
# Or manual activation
623+
nix develop
610624
```
611625

612626
The flake provides all necessary development dependencies including Node.js, pnpm, and other build tools.

0 commit comments

Comments
 (0)