Skip to content

Commit ae9b69a

Browse files
committed
docs(book): update build instructions for Linux with just
Signed-off-by: k4yt3x <i@k4yt3x.com>
1 parent 6ab1759 commit ae9b69a

File tree

1 file changed

+14
-10
lines changed

1 file changed

+14
-10
lines changed

docs/book/src/building/linux.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,47 +4,51 @@ Instructions for building this project on Linux.
44

55
## Arch Linux
66

7-
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`.
7+
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`.
88

99
```bash
10-
# Build only
11-
git clone https://aur.archlinux.org/video2x-git.git
10+
git clone https://aur.archlinux.org/video2x.git
1211
cd video2x-git
12+
13+
# Build the package without installing it
1314
makepkg -s
15+
16+
# Build and install the package
17+
makepkg -si
1418
```
1519

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

1822
```bash
1923
# Install build and runtime dependencies
2024
# See the PKGBUILD file for the list of up-to-date dependencies
21-
pacman -Sy ffmpeg ncnn vulkan-driver opencv spdlog boost-libs
22-
pacman -Sy git cmake make clang pkgconf vulkan-headers openmp boost
25+
pacman -Sy ffmpeg ncnn vulkan-driver spdlog boost-libs
26+
pacman -Sy git cmake clang pkgconf just vulkan-headers openmp boost
2327

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

2832
# Build the project
29-
make build
33+
just build
3034
```
3135

3236
The built binaries will be located in the `build` directory.
3337

3438
## Ubuntu
3539

36-
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.
40+
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.
3741

3842
```bash
39-
# make needs to be installed manually
40-
sudo apt-get update && sudo apt-get install make
43+
# just needs to be installed manually
44+
sudo apt-get update && sudo apt-get install just
4145

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

4650
# Build the project
47-
make ubuntu2404
51+
just ubuntu2404
4852
```
4953

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

0 commit comments

Comments
 (0)