From b072ba163904864afe973a938cf4039314bfd15c Mon Sep 17 00:00:00 2001 From: flexxyfluxx <82163962+flexxyfluxx@users.noreply.github.com> Date: Tue, 11 Jun 2024 12:24:00 +0000 Subject: Improve NixOS install instructions in Readme --- README.md | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 37ebcf42..4a8be641 100644 --- a/README.md +++ b/README.md @@ -110,10 +110,36 @@ sudo urpmi nheko #### Nix(os) ```bash +# Imperatively: (not recommended) nix-env -iA nixpkgs.nheko -# or + +# In an ephemeral shell: (recommended if you just want to try it out without committing to a full installation) nix-shell -p nheko --run nheko ``` +Alternatively, add it to your config in one of the following ways: (recommended for long-term installation) + +**System-wide:** +```nix +environment.systemPackages = with pkgs; [ + # ... + nheko + # ... +]; +``` +**User-specific:** +```nix +users.users..packages = with pkgs; [ + # ... + nheko + # ... +]; +``` +**via `home-manager`:** +```nix +programs.nheko.enable = true; +``` + + #### Alpine Linux (and postmarketOS) -- cgit 1.5.1 From 49ac5049c3a6f537075d9164b9fabd49ee05f33f Mon Sep 17 00:00:00 2001 From: flexxyfluxx <82163962+flexxyfluxx@users.noreply.github.com> Date: Tue, 11 Jun 2024 12:36:44 +0000 Subject: add further clarification to `nix-shell` install method --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 4a8be641..0f88462e 100644 --- a/README.md +++ b/README.md @@ -115,6 +115,8 @@ nix-env -iA nixpkgs.nheko # In an ephemeral shell: (recommended if you just want to try it out without committing to a full installation) nix-shell -p nheko --run nheko +# Note: The above command will both install and run Nheko. +# To stop it from running immediately, just remove the `--run nheko` from the end. ``` Alternatively, add it to your config in one of the following ways: (recommended for long-term installation) -- cgit 1.5.1