Linux

Instructions for building this project on Linux.

Arch Linux

Arch users can build the latest version of the project from the AUR packages video2x and video2x-git. The project's repository also contains another PKGBUILD example at packaging/arch/PKGBUILD.

git clone https://aur.archlinux.org/video2x.git
cd video2x-git

# Build the package without installing it
makepkg -s

# Build and install the package
makepkg -si

To build manually from the source, follow the instructions below.

# Install build and runtime dependencies
# See the PKGBUILD file for the list of up-to-date dependencies
pacman -Sy ffmpeg ncnn vulkan-driver spdlog boost-libs
pacman -Sy git cmake clang pkgconf just vulkan-headers openmp boost

# Clone the repository
git clone --recurse-submodules https://github.com/k4yt3x/video2x.git
cd video2x

# Build the project
just build

The built binaries will be located in the build directory.

Ubuntu

Ubuntu users can use the .justfile to build the project automatically. The ubuntu2404 and ubuntu2204 targets are available for Ubuntu 24.04 and 22.04, respectively. just will automatically install the required dependencies, build the project, and package it into a .deb package file. It is recommended to perform the build in a container to ensure the environment's consistency and to avoid leaving extra build packages on your system.

# The version of `just` in the Ubuntu repository is outdated
# We need to compile and install `just` manually
sudo apt-get update && sudo apt-get install cargo
cargo install just

# Clone the repository
git clone --recurse-submodules https://github.com/k4yt3x/video2x.git
cd video2x

# Build the project
# Before running the command, ensure ~/.cargo/bin is in your PATH
just ubuntu2404

The built .deb package will be located under the current directory.