From f6517cdcb44970e18598c6c9413a322065ad476f Mon Sep 17 00:00:00 2001 From: Dhruv Bhanushali Date: Wed, 6 Nov 2024 23:49:57 +0400 Subject: [PATCH] Add instructions for using Nix --- docs/src/content/docs/guides/get_started.mdx | 31 ++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/docs/src/content/docs/guides/get_started.mdx b/docs/src/content/docs/guides/get_started.mdx index 200167e..e7ca2f4 100644 --- a/docs/src/content/docs/guides/get_started.mdx +++ b/docs/src/content/docs/guides/get_started.mdx @@ -40,6 +40,7 @@ These are the different ways you can install on your machine. :::note We are working on adding to more package managers like `apt` and `dnf`. +If you add to a package manager or repository, please let us know! ::: @@ -55,6 +56,36 @@ brew install pls-rs/pls/pls This command will fetch and install the latest release of from GitHub. +### Nix + + is also available as a [Nix +package](https://search.nixos.org/packages?show=pls). You can install it using +`nix-env`, add it to your NixOS configuration or just try it using `nix-shell`. + +To permanently add to NixOS, update your config, usually located at +`/etc/nixos/configuration.nix`. + +```nix +environment.systemPackages = [ + pkgs.pls +]; +``` + +:::note + +Thanks to [TomaSajt](https://github.com/TomaSajt) for creating this package and +to +[all its maintainers](https://github.com/NixOS/nixpkgs/commits/master/pkgs/by-name/pl/pls/package.nix). + +::: + +:::caution + +Since `nixpkgs` is a massive centralised repository, obtained from there +might be out of date. + +::: + ### Build from source If you have the Rust toolchain installed on your computer, you can build from