serenity/Documentation/BuildInstructionsOther.md

# Installing build requisites on other systems

### Fedora

```console
sudo dnf install texinfo binutils-devel curl cmake mpfr-devel libmpc-devel gmp-devel e2fsprogs ninja-build patch ccache rsync @"C Development Tools and Libraries" @Virtualization
```
Optional: `fuse2fs` for [building images without root](https://github.com/SerenityOS/serenity/pull/11224).

## openSUSE

```console
sudo zypper install curl cmake mpfr-devel mpc-devel ninja gmp-devel e2fsprogs patch qemu-x86 qemu-audio-pa gcc gcc-c++ ccache rsync patterns-devel-C-C++-devel_C_C++
```

## Void Linux

```console
sudo xbps-install -S base-devel cmake curl mpfr-devel libmpc-devel gmp-devel e2fsprogs ninja qemu ccache rsync
```

## ALT Linux

```console
apt-get install curl cmake libmpc-devel gmp-devel e2fsprogs libmpfr-devel ninja-build patch gcc ccache rsync
```

## NixOS

You can use the flake in the root directory to enter a devShell that has all the required packages and tools to build SerenityOS:

```console
nix develop
```

Or you can use the legacy `nix-shell` tool to enter the devShell:

```console
nix-shell Toolchain
```

This will use the `Toolchain/default.nix` file and your host `nixpkgs`.

## Alpine Linux

First, make sure you have enabled the `community` repository in `/etc/apk/repositories` and run `apk update`. It has been tested on `edge`, YMMV on `stable`.

```console
# the basics, if you have not already done so
apk add bash curl git util-linux sudo

# GNU coreutils for GNU's version of `du`
apk add coreutils

# rough equivalent of build-essential
apk add build-base

# qemu
apk add qemu qemu-system-x86_64 qemu-img qemu-ui-gtk qemu-audio-pa

# build tools (samurai is a drop-in replacement for ninja)
apk add cmake e2fsprogs grub-bios samurai mpc1-dev mpfr-dev gmp-dev ccache rsync texinfo
```
Optional: `fuse2fs` for [building images without root](https://github.com/SerenityOS/serenity/pull/11224).

## OpenBSD prerequisites

```console
doas pkg_add bash cmake g++ gcc git gmake gmp ninja ccache rsync coreutils qemu sudo e2fsprogs
```

## FreeBSD prerequisites

```console
pkg install qemu bash cmake coreutils e2fsprogs fusefs-ext2 gcc11 git gmake ninja sudo gmp mpc mpfr ccache rsync
```
Optional: `fusefs-ext2` for [building images without root](https://github.com/SerenityOS/serenity/pull/11224).
Documentation: Reorganize the build documentation 2021-07-09 22:53:28 +00:00			`# Installing build requisites on other systems`

Documentation: Shuffle around systems in the build instruction docs The crowd has spoken and it's clear they want... Windows and Arch Linux. 2021-07-11 20:19:11 +00:00			`### Fedora`
Documentation: Reorganize the build documentation 2021-07-09 22:53:28 +00:00
			```console
Documentation: Add texinfo as a dependency for Fedora 2022-02-19 14:09:34 +00:00			`sudo dnf install texinfo binutils-devel curl cmake mpfr-devel libmpc-devel gmp-devel e2fsprogs ninja-build patch ccache rsync @"C Development Tools and Libraries" @Virtualization`
Documentation: Reorganize the build documentation 2021-07-09 22:53:28 +00:00			```
Documentation: Add instructions for building images without root I could not find the fuse2fs or equivalent packages for the other distros, so it is represented separately for each distro that does have it. 2022-04-04 07:23:22 +00:00			Optional: `fuse2fs` for [building images without root](https://github.com/SerenityOS/serenity/pull/11224).
Documentation: Reorganize the build documentation 2021-07-09 22:53:28 +00:00
Documentation: Shuffle around systems in the build instruction docs The crowd has spoken and it's clear they want... Windows and Arch Linux. 2021-07-11 20:19:11 +00:00			`## openSUSE`
Documentation: Reorganize the build documentation 2021-07-09 22:53:28 +00:00
			```console
Documentation: Shuffle around systems in the build instruction docs The crowd has spoken and it's clear they want... Windows and Arch Linux. 2021-07-11 20:19:11 +00:00			`sudo zypper install curl cmake mpfr-devel mpc-devel ninja gmp-devel e2fsprogs patch qemu-x86 qemu-audio-pa gcc gcc-c++ ccache rsync patterns-devel-C-C++-devel_C_C++`
Documentation: Reorganize the build documentation 2021-07-09 22:53:28 +00:00			```

			`## Void Linux`

			```console
			`sudo xbps-install -S base-devel cmake curl mpfr-devel libmpc-devel gmp-devel e2fsprogs ninja qemu ccache rsync`
			```

			`## ALT Linux`

			```console
			`apt-get install curl cmake libmpc-devel gmp-devel e2fsprogs libmpfr-devel ninja-build patch gcc ccache rsync`
			```

			`## NixOS`

nix: Clean up files, use good practices 2024-03-16 08:36:09 +00:00			`You can use the flake in the root directory to enter a devShell that has all the required packages and tools to build SerenityOS:`
Documentation: Reorganize the build documentation 2021-07-09 22:53:28 +00:00
Toolchain: Move nix script from Documentation into Toolchain Moves the nix script to setup the build environment from Documentation into the Toolchain as a callable script. I also modified the script to accept a "pkgs" argument to make it easy to override the nixpkgs version from the command-line when calling the script. 2022-03-08 04:12:55 +00:00			```console
nix: Clean up files, use good practices 2024-03-16 08:36:09 +00:00			`nix develop`
Documentation: Reorganize the build documentation 2021-07-09 22:53:28 +00:00			```

nix: Clean up files, use good practices 2024-03-16 08:36:09 +00:00			Or you can use the legacy `nix-shell` tool to enter the devShell:
Toolchain: Add nix flake Add a nix flake to `Toolchain/` that wraps the existing nix derivation `Toolchain/serenity.nix`. This also comes with a lockfile making the nix developer enviornment setup more reproducible. We also update the documentation for "other builds" to mention the flake. 2023-08-31 13:39:47 +00:00
			```console
nix: Clean up files, use good practices 2024-03-16 08:36:09 +00:00			`nix-shell Toolchain`
Toolchain: Add nix flake Add a nix flake to `Toolchain/` that wraps the existing nix derivation `Toolchain/serenity.nix`. This also comes with a lockfile making the nix developer enviornment setup more reproducible. We also update the documentation for "other builds" to mention the flake. 2023-08-31 13:39:47 +00:00			```

nix: Clean up files, use good practices 2024-03-16 08:36:09 +00:00			This will use the `Toolchain/default.nix` file and your host `nixpkgs`.
Toolchain: Add Toolchain/nix-profiles/ to .gitignore Let users save their nix develop derivation in a profile by ignoring this specific folder. It encourages the following workflow: ``` nix develop Toolchain/ --profile Toolchain/nix-profiles/dev ``` Which stops the dev enviornment being collected in the nix store. Later devs can come back and do: ``` nix develop Toolchain/nix-profiles/dev ``` To continue where they left off, without having to download everything from nixpkgs again. 2023-08-31 14:29:27 +00:00
Documentation: Reorganize the build documentation 2021-07-09 22:53:28 +00:00			`## Alpine Linux`

			First, make sure you have enabled the `community` repository in `/etc/apk/repositories` and run `apk update`. It has been tested on `edge`, YMMV on `stable`.

			```console
			`# the basics, if you have not already done so`
			`apk add bash curl git util-linux sudo`

Documentation: Add coreutils dep to Alpine Linux build instructions `build-image-qemu.sh` depends on GNU's version of `du`: https://github.com/SerenityOS/serenity/blob/43d706a29e6d0ccdacb4907981a27c3bf176d5e8/Meta/build-image-qemu.sh#L47-L48 Alpine Linux doesn't use that version by default. 2022-02-11 03:04:51 +00:00			# GNU coreutils for GNU's version of `du`
			`apk add coreutils`

Documentation: Reorganize the build documentation 2021-07-09 22:53:28 +00:00			`# rough equivalent of build-essential`
			`apk add build-base`

			`# qemu`
Documentation: Add dependencies for alpine linux - Add qemu-audio-pa for the audio driver - Change qemu i386 with x86_64 - Mention fuse2fs for building. 2023-08-10 16:28:27 +00:00			`apk add qemu qemu-system-x86_64 qemu-img qemu-ui-gtk qemu-audio-pa`
Documentation: Reorganize the build documentation 2021-07-09 22:53:28 +00:00
			`# build tools (samurai is a drop-in replacement for ninja)`
Documentation: Add texinfo as a dependency for Alpine Linux 2022-03-02 01:20:13 +00:00			`apk add cmake e2fsprogs grub-bios samurai mpc1-dev mpfr-dev gmp-dev ccache rsync texinfo`
Documentation: Reorganize the build documentation 2021-07-09 22:53:28 +00:00			```
Documentation: Add dependencies for alpine linux - Add qemu-audio-pa for the audio driver - Change qemu i386 with x86_64 - Mention fuse2fs for building. 2023-08-10 16:28:27 +00:00			Optional: `fuse2fs` for [building images without root](https://github.com/SerenityOS/serenity/pull/11224).
Documentation: Reorganize the build documentation 2021-07-09 22:53:28 +00:00
			`## OpenBSD prerequisites`

			```console
Meta+Documentation: Don't rebuild disk image for every run on OpenBSD 2021-12-24 16:00:08 +00:00			`doas pkg_add bash cmake g++ gcc git gmake gmp ninja ccache rsync coreutils qemu sudo e2fsprogs`
Documentation: Reorganize the build documentation 2021-07-09 22:53:28 +00:00			```

			`## FreeBSD prerequisites`

			```console
Documentation: Change/add two pkgs in the FreeBSD instructions 2022-02-14 13:32:58 +00:00			`pkg install qemu bash cmake coreutils e2fsprogs fusefs-ext2 gcc11 git gmake ninja sudo gmp mpc mpfr ccache rsync`
Documentation: Reorganize the build documentation 2021-07-09 22:53:28 +00:00			```
Documentation: Add instructions for building images without root I could not find the fuse2fs or equivalent packages for the other distros, so it is represented separately for each distro that does have it. 2022-04-04 07:23:22 +00:00			Optional: `fusefs-ext2` for [building images without root](https://github.com/SerenityOS/serenity/pull/11224).