Skip to content

Commit

Permalink
Merge pull request #7 from arexon/nix-installation
Browse files Browse the repository at this point in the history
Add installation info for Nix/NixOS
  • Loading branch information
Nusiq authored Feb 1, 2025
2 parents 7068f4d + a7d2ee4 commit 2190088
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion docs/introduction/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,22 @@ regolith-update.ps1

The script will check for available updates to Regolith and install them.

## Nix (Linux)

Regolith is available in [nixpkgs](https://github.com/nixos/nixpkgs) with the `regolith` attribute. The unstable channel usually includes the latest release.

```text
nix-shell -p regolith
```

Alternatively if you're using NixOS, you can install Regolith by adding the following to your `configuration.nix` file:

```nix
environment.systemPackages = [
pkgs.regolith
];
```

## Stand-alone Executable File (Linux, Mac, and Windows)

Regolith can also be installed as a stand-alone executable. Download the appropriate ZIP file for your operating system from the [GitHub release page](https://github.com/Bedrock-OSS/regolith/releases/latest).
Expand All @@ -64,4 +80,4 @@ After installing, Regolith can be used in command-prompt by typing `regolith`. Y

```{note}
If you don't see this try restarting your terminal. If you encounter any issues, please refer to the {ref}`troubleshooting guide<troubleshooting>` for tips.
```
```

0 comments on commit 2190088

Please sign in to comment.