From fdac640425801266b89bac73f3736805651d0468 Mon Sep 17 00:00:00 2001 From: Alexander Date: Fri, 9 Jan 2026 16:26:42 +0300 Subject: [PATCH] docs: add nix setup instructions --- CONTRIBUTING.md | 12 ++++++++++++ README.md | 10 ++++++++++ 2 files changed, 22 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index db8401a..6c5e895 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -31,6 +31,18 @@ When you submit your first pull request, you acknowledge that you agree to the t ## Development Setup +### Using Nix (Recommended for Linux) + +If you have [Nix](https://nixos.org/) installed, you can skip the manual setup below and simply run: + +```bash +nix develop +``` + +This will provide Node.js, Rust, and all necessary system libraries. + +### Manual Setup + Ensure you have the following dependencies installed: - Node.js (see `.node-version` for exact version) diff --git a/README.md b/README.md index 6d40c12..b5e02f6 100644 --- a/README.md +++ b/README.md @@ -59,6 +59,16 @@ The app can be downloaded from the [releases page](https://github.com/zhom/donut See [CONTRIBUTING.md](CONTRIBUTING.md). +### Nix Support + +For a reproducible development environment (especially on Linux), you can use [Nix](https://nixos.org/): + +```bash +nix develop +# or if you use direnv +direnv allow +``` + ## Issues If you face any problems while using the application, please [open an issue](https://github.com/zhom/donutbrowser/issues).