summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
authorDeepBlueV7.X <nicolas.werner@hotmail.de>2024-06-16 20:21:56 +0000
committerGitHub <noreply@github.com>2024-06-16 20:21:56 +0000
commitdbdbb5ef75d965ca995295faaef469c324f5e055 (patch)
tree1a1fad743e404a054fe90a13fdadd6196f1f3db3 /README.md
parentMerge pull request #1747 from ell1e/patch-1 (diff)
parentadd further clarification to `nix-shell` install method (diff)
downloadnheko-dbdbb5ef75d965ca995295faaef469c324f5e055.tar.xz
Merge pull request #1748 from flexxyfluxx/patch-1
Readme: Clarify and fill in missing information for Nix(OS) install instructions
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 29 insertions, 1 deletions
diff --git a/README.md b/README.md
index 2dc297d5..41b32886 100644
--- a/README.md
+++ b/README.md
@@ -113,10 +113,38 @@ 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
+# 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)
+
+**System-wide:**
+```nix
+environment.systemPackages = with pkgs; [
+    # ...
+    nheko
+    # ...
+];
+```
+**User-specific:**
+```nix
+users.users.<user>.packages = with pkgs; [
+    # ...
+    nheko
+    # ...
+];
 ```
+**via `home-manager`:**
+```nix
+programs.nheko.enable = true;
+```
+
+
 
 #### Alpine Linux (and postmarketOS)