Debian / Ubuntu
Install Dependencies
Install build tools and libraries
sudo apt install build-essential cmake curl libmpfr-dev libmpc-dev \
libgmp-dev e2fsprogs ninja-build qemu-system-gui qemu-system-x86 \
qemu-utils ccache rsync unzip texinfo libssl-dev zlib1g-dev
Optional: Install fuse2fs for building images without root privileges.
Install GCC 14 or Clang 17+
On Ubuntu 24.04 (Noble) and later:sudo apt update
sudo apt install gcc-14 g++-14
Use the LLVM apt repositories:sudo apt update
sudo apt install libclang-19-dev clang-19 llvm-19 llvm-19-dev
The -dev packages are only necessary when Jakt is enabled.
Install QEMU 6.2 or later
Ubuntu 22.04 and later include QEMU 6.2. For earlier versions, build from source:# Install QEMU build dependencies
sudo apt install libgtk-3-dev libpixman-1-dev libsdl2-dev \
libslirp-dev libspice-server-dev
# Build QEMU from toolchain
Toolchain/BuildQemu.sh
Verify CMake version
CMake 3.25.0 or later is required. If your version is older:# The build scripts will automatically build CMake from source
# If you have old CMake cache files, remove them:
rm Build/*/CMakeCache.txt
Build and Run
If you see fusermount: failed to open /etc/mtab: No such file or directory, create the symlink:sudo ln -sv /proc/self/mounts /etc/mtab
Arch Linux / Manjaro
Install Dependencies
sudo pacman -S --needed base-devel cmake curl mpfr libmpc gmp e2fsprogs \
ninja qemu-desktop qemu-system-aarch64 ccache rsync unzip
fuse2fs - For building images without rootclang llvm llvm-libs - For building with Clang
Build and Run
Fedora
Install Dependencies
sudo dnf install texinfo binutils-devel curl cmake mpfr-devel \
libmpc-devel gmp-devel e2fsprogs ninja-build patch ccache rsync \
@development-tools @c-development @virtualization
e2fsprogs package for building images without root.
openSUSE
Install Dependencies
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
Install Dependencies
sudo xbps-install -S base-devel cmake curl mpfr-devel libmpc-devel \
gmp-devel e2fsprogs ninja qemu ccache rsync
ALT Linux
Install Dependencies
apt-get install curl cmake libmpc-devel gmp-devel e2fsprogs \
libmpfr-devel ninja-build patch gcc ccache rsync
NixOS
Using Flakes
The repository includes a flake with all required dependencies:
Using Legacy nix-shell
This uses Toolchain/default.nix and your host nixpkgs.
Alpine Linux
Tested on edge. YMMV on stable.
Install Dependencies
Enable community repository
Edit /etc/apk/repositories to enable the community repository, then: Install basic tools
apk add bash curl git util-linux sudo
Install QEMU
apk add qemu qemu-system-x86_64 qemu-img qemu-ui-gtk qemu-audio-pa
Install development libraries
apk add cmake e2fsprogs grub-bios samurai mpc1-dev mpfr-dev gmp-dev \
ccache rsync texinfo
samurai is a drop-in replacement for ninja.
OpenBSD
Install Dependencies
doas pkg_add bash cmake g++ gcc git gmake gmp ninja ccache rsync \
coreutils qemu sudo e2fsprogs
FreeBSD
Install Dependencies
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.
Building on SerenityOS
You can build SerenityOS on SerenityOS itself!
Install Required Ports
bash cmake curl e2fsprogs gawk genext2fs git ninja patch python3 qemu rsync
# Install gcc, gmp and mpc ports
/bin/sh to /usr/local/bin/bash:
ln -sf /usr/local/bin/bash mnt/bin/sh
Ports
To build a port, navigate to its directory and run the package script:
cd Ports/curl
./package.sh
Common Port Dependencies
sudo apt install autoconf automake bison flex gettext gperf \
help2man imagemagick libgpg-error-dev libtool lzip meson nasm \
python3-packaging qt6-base-dev rename zip
file (version 5.44 exactly, for file port)libpython3-dev (for boost)lua (for luarocks)openjdk-17-jdk (for OpenJDK)p7zip-full (for msttcorefonts)rake (for mruby)
Some ports require a symlink from /usr/bin/python to /usr/bin/python3.
Troubleshooting
If prompted to rebuild the toolchain:
# Remove old toolchain
rm -rf Toolchain/Local
# Rebuild
Meta/serenity.sh rebuild-toolchain
CMake Cache Issues
If CMake complains about version mismatches:
rm Build/*/CMakeCache.txt
Next Steps
Advanced Build Options
Explore CMake options, build configurations, and customization
