Skip to content

Commit

Permalink
Add instructions for using Nix
Browse files Browse the repository at this point in the history
  • Loading branch information
dhruvkb committed Nov 6, 2024
1 parent d97ee48 commit f6517cd
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions docs/src/content/docs/guides/get_started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ These are the different ways you can install <Pls /> on your machine.
:::note

We are working on adding <Pls /> to more package managers like `apt` and `dnf`.
If you add <Pls /> to a package manager or repository, please let us know!

:::

Expand All @@ -55,6 +56,36 @@ brew install pls-rs/pls/pls

This command will fetch and install the latest release of <Pls /> from GitHub.

### Nix

<Pls /> 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 <Pls /> 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, <Pls /> 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
Expand Down

0 comments on commit f6517cd

Please sign in to comment.