From 42d244b5e4564cd9c2db0221785e0ddb0f9f2fce Mon Sep 17 00:00:00 2001 From: Guillaume Fournier <> Date: Mon, 6 Nov 2023 16:10:22 +0100 Subject: [PATCH 1/2] Add documentation for nixos installation --- book/src/cli-installation.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/book/src/cli-installation.md b/book/src/cli-installation.md index 84ab29f9..b082d685 100644 --- a/book/src/cli-installation.md +++ b/book/src/cli-installation.md @@ -30,6 +30,36 @@ AUR package, which will download the source and compile it. yay -S numbat ``` +## NixOs + +*... or any distribution where nix is installed.* + +### nix-env + +> **Warning:** Using nix-env permanently modifies a local profile of installed packages. This must be updated and maintained by the user in the same way as with a traditional package manager, foregoing many of the benefits that make Nix uniquely powerful. Using nix-shell or a NixOS configuration is recommended instead. + +``` bash +nix-env -iA nixpkgs.numbat +``` + +### nix-shell + +A nix-shell will temporarily modify your $PATH environment variable. This can be used to try a piece of software before deciding to permanently install it. + +``` bash +nix-shell -p numbat +``` + +### NixOs Configuration + +Add the following Nix code to your NixOS Configuration, usually located in /etc/nixos/configuration.nix + +``` nix +environment.systemPackages = [ + pkgs.numbat +]; +``` + ## macOS ### Homebrew From 307d3bf690ea9e0e62e30e3f2bbea664434375af Mon Sep 17 00:00:00 2001 From: Guillaume Fournier <> Date: Mon, 6 Nov 2023 20:03:28 +0100 Subject: [PATCH 2/2] shorten nixos documentation --- book/src/cli-installation.md | 17 ++--------------- 1 file changed, 2 insertions(+), 15 deletions(-) diff --git a/book/src/cli-installation.md b/book/src/cli-installation.md index b082d685..4fa7b73d 100644 --- a/book/src/cli-installation.md +++ b/book/src/cli-installation.md @@ -34,25 +34,12 @@ yay -S numbat *... or any distribution where nix is installed.* -### nix-env - -> **Warning:** Using nix-env permanently modifies a local profile of installed packages. This must be updated and maintained by the user in the same way as with a traditional package manager, foregoing many of the benefits that make Nix uniquely powerful. Using nix-shell or a NixOS configuration is recommended instead. +Install [numbat](https://search.nixos.org/packages?channel=unstable&show=numbat&from=0&size=50&sort=relevance&type=packages&query=numbat) to your profile: ``` bash nix-env -iA nixpkgs.numbat ``` - -### nix-shell - -A nix-shell will temporarily modify your $PATH environment variable. This can be used to try a piece of software before deciding to permanently install it. - -``` bash -nix-shell -p numbat -``` - -### NixOs Configuration - -Add the following Nix code to your NixOS Configuration, usually located in /etc/nixos/configuration.nix +Or add it to your NixOs Configuration: ``` nix environment.systemPackages = [