OpenSourceJoker/video2x
3
0
Fork 0
mirror of https://github.com/k4yt3x/video2x.git synced 2025-01-15 12:18:52 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs(book): update build instructions for Linux with just
Some checks failed
Docs / deploy (push) Has been cancelled
Details

Browse Source 
Signed-off-by: k4yt3x <i@k4yt3x.com>
This commit is contained in:
k4yt3x 2025-01-10 00:00:00 +00:00
parent 6ab1759e1a
commit ae9b69ac2e
No known key found for this signature in database
1 changed files with 14 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/book/src/building/linux.md
View File

@ -4,13 +4,17 @@ Instructions for building this project on Linux.
## Arch Linux ## Arch Linux
Arch users can build the latest version of the project from the AUR package `video2x-git`. The project's repository also contains another PKGBUILD example at `packaging/arch/PKGBUILD`. Arch users can build the latest version of the project from the AUR packages [`video2x`](https://aur.archlinux.org/packages/video2x) and [`video2x-git`](https://aur.archlinux.org/packages/video2x-git). The project's repository also contains another PKGBUILD example at `packaging/arch/PKGBUILD`.
```bash ```bash
# Build only git clone https://aur.archlinux.org/video2x.git
git clone https://aur.archlinux.org/video2x-git.git
cd video2x-git cd video2x-git
# Build the package without installing it
makepkg -s makepkg -s
# Build and install the package
makepkg -si
``` ```
To build manually from the source, follow the instructions below. To build manually from the source, follow the instructions below.
@ -18,33 +22,33 @@ To build manually from the source, follow the instructions below.
```bash ```bash
# Install build and runtime dependencies # Install build and runtime dependencies
# See the PKGBUILD file for the list of up-to-date dependencies # See the PKGBUILD file for the list of up-to-date dependencies
pacman -Sy ffmpeg ncnn vulkan-driver opencv spdlog boost-libs pacman -Sy ffmpeg ncnn vulkan-driver spdlog boost-libs
pacman -Sy git cmake make clang pkgconf vulkan-headers openmp boost pacman -Sy git cmake clang pkgconf just vulkan-headers openmp boost
# Clone the repository # Clone the repository
git clone --recurse-submodules https://github.com/k4yt3x/video2x.git git clone --recurse-submodules https://github.com/k4yt3x/video2x.git
cd video2x cd video2x
# Build the project # Build the project
make build just build
``` ```
The built binaries will be located in the `build` directory. The built binaries will be located in the `build` directory.
## Ubuntu ## Ubuntu
Ubuntu users can use the `Makefile` to build the project automatically. The `ubuntu2404` and `ubuntu2204` targets are available for Ubuntu 24.04 and 22.04, respectively. `make` 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. 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.
```bash ```bash
# make needs to be installed manually # just needs to be installed manually
sudo apt-get update && sudo apt-get install make sudo apt-get update && sudo apt-get install just
# Clone the repository # Clone the repository
git clone --recurse-submodules https://github.com/k4yt3x/video2x.git git clone --recurse-submodules https://github.com/k4yt3x/video2x.git
cd video2x cd video2x
# Build the project # Build the project
make ubuntu2404 just ubuntu2404
``` ```
The built `.deb` package will be located under the current directory. The built `.deb` package will be located under the current directory.