Skip to content

Commit

Permalink
Merge pull request #4167 from systeminit/nick/5c098c5
Browse files Browse the repository at this point in the history
Reflect NixOS compatibility in the docs
  • Loading branch information
nickgerace authored Jul 17, 2024
2 parents f3a6dcf + 05e985c commit 26f08ca
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 12 deletions.
10 changes: 7 additions & 3 deletions DOCS.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,12 +61,16 @@ We have a section further down that describes how to intervene.
### Linux

Linux (GNU) is officially supported on both x86_64 (amd64) and aarch64 (arm64) architectures.
[NixOS](https://nixos.org/) is not supported at this time, but may be desired in the future.
Linux with MUSL instead of GNU is also not currently supported.
Linux with MUSL instead of GNU is untested.

In general, GNU-based distros that are roughly [FHS-compliant](https://en.wikipedia.org/wiki/Filesystem_Hierarchy_Standard) will work.
In general, GNU-based distros will work.
Those include, but are not limited to the following: Ubuntu, Fedora, Debian, Arch Linux, and openSUSE.

#### What about NixOS?

If using NixOS, you need [Docker](https://nixos.wiki/wiki/Docker) to be installed and [Flakes](https://nixos.wiki/wiki/Flakes) to be enabled.
If not using `direnv`, you can use `nix develop` or [Nix command](https://nixos.wiki/wiki/Nix_command).

### Windows

Using native Windows is not supported at this time, but may be desired in the future.
Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@ Let's start by choosing an officially supported platform.

**Platform Notes:**
* On Apple Silicon systems (i.e. macOS aarch64 (arm64)), Rosetta 2 must be installed (install it with `softwareupdate --install-rosetta`)
* [NixOS](https://nixos.org/) and Linux with MUSL instead of GNU (e.g. [Alpine Linux](https://www.alpinelinux.org/)) will not likely work at this time
* [NixOS](https://nixos.org/) requires [`docker`](https://nixos.wiki/wiki/Docker) to be installed and [Flakes](https://nixos.wiki/wiki/Flakes) to be enabled (see the [development environment section of the docs](DOCS.md) for more information)
* Linux with MUSL instead of GNU (e.g. [Alpine Linux](https://www.alpinelinux.org/)) is untested
* Systemd may need to be enabled on WSL2

### (2) Install Dependencies
Expand Down
19 changes: 11 additions & 8 deletions app/docs/src/reference/dev/development-environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,17 @@ intervention. We have a section further down that describes how to intervene.
### Linux

Linux (GNU) is officially supported on both x86_64 (amd64) and aarch64 (arm64)
architectures. [NixOS](https://nixos.org/) is not supported at this time, but
may be desired in the future. Linux with MUSL instead of GNU is also not
currently supported.

In general, GNU-based distros that are roughly
[FHS-compliant](https://en.wikipedia.org/wiki/Filesystem_Hierarchy_Standard)
will work. Those include, but are not limited to the following: Ubuntu, Fedora,
Debian, Arch Linux, and openSUSE.
architectures. Linux with MUSL instead of GNU is untested.

In general, GNU-based distros will work. Those include, but are not limited to
the following: Ubuntu, Fedora, Debian, Arch Linux, and openSUSE.

#### What about NixOS?

If using NixOS, you need [Docker](https://nixos.wiki/wiki/Docker) to be
installed and [Flakes](https://nixos.wiki/wiki/Flakes) to be enabled. If not
using `direnv`, you can use `nix develop` or
[Nix command](https://nixos.wiki/wiki/Nix_command).

### Windows

Expand Down

0 comments on commit 26f08ca

Please sign in to comment.