Documentation: Improve nix related commands

This patch fixes `nix develop` commands not using proper paths, uses
the serenity root directory as an assumption for all commands and
adds variants of nix commands to use a custom entry point, for example
a shell.
This commit is contained in:
networkException 2023-12-04 02:13:55 +01:00 committed by Sam Atkins
parent 20162874e0
commit b95e7772e7
Notes: sideshowbarker 2024-07-19 01:59:31 +09:00
2 changed files with 22 additions and 7 deletions

View file

@ -34,13 +34,22 @@ On openSUSE:
sudo zypper install cmake libglvnd-devel ninja qt6-base-devel qt6-multimedia-devel qt6-tools-devel qt6-wayland-devel ccache
```
On Nix/NixOS:
```
nix-shell ladybird.nix
On Nix/NixOS (using your host nixpkgs):
```bash
# From /path/to/serenity
nix-shell Ladybird/ladybird.nix
# With a custom entrypoint, for example your favorite shell
nix-shell --command bash Ladybird/ladybird.nix
```
You can also use the nix flake in `Toolchain`:
```
nix develop Toolchain/#ladybird
```bash
# From /path/to/serenity
nix develop ./Toolchain#ladybird
# With a custom entrypoint, for example your favorite shell
nix develop ./Toolchain#ladybird --command bash
```
On macOS:

View file

@ -27,16 +27,22 @@ apt-get install curl cmake libmpc-devel gmp-devel e2fsprogs libmpfr-devel ninja-
## NixOS
You can use the `nix-shell` script [`Toolchain/serenity.nix`](../Toolchain/serenity.nix) to set up the environment:
You can use the `nix-shell` script [`Toolchain/serenity.nix`](../Toolchain/serenity.nix) to set up the environment (using your host nixpkgs):
```console
nix-shell Toolchain/serenity.nix
# With a custom entrypoint, for example your favorite shell
nix-shell --command bash Toolchain/serenity.nix
```
or you can use the nix flake [`Toolchain/flake.nix`](../Toolchain/flake.nix) instead:
```console
nix develop Toolchain
nix develop ./Toolchain#
# With a custom entrypoint, for example your favorite shell
nix develop ./Toolchain# --command bash
```
You can also save this environment to a profile: