Hypr Ecosystem/hyprpaper: update docs (#819)

Add instalation, run at startup and link to the documentation.
This commit is contained in:
Mauricio Borawski 2024-10-23 12:05:51 -03:00 committed by GitHub
parent c0f46b5520
commit 99cbe68dbf
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -5,6 +5,83 @@ title: hyprpaper
hyprpaper is a fast, IPC-controlled wallpaper utility for Hyprland. hyprpaper is a fast, IPC-controlled wallpaper utility for Hyprland.
## Installation
{{% details title="Arch" closed="true" %}}
```sh
pacman -S hyprpaper
```
{{% /details %}}
{{% details title="OpenSuse" closed="true" %}}
```sh
zypper install hyprpaper
```
{{% /details %}}
{{% details title="Fedora" closed="true" %}}
```sh
sudo dnf install hyprpaper
```
{{% /details %}}
{{% details title="Manual" closed="true" %}}
### Dependencies
The development files of these packages need to be installed on the system for `hyprpaper` to build correctly.
(Development packages are usually suffixed with `-dev` or `-devel` in most distros' repos).
- wayland
- wayland-protocols
- pango
- cairo
- file
- libglvnd
- libglvnd-core
- libjpeg-turbo
- libwebp
- hyprlang
- hyprutils
- hyprwayland-scanner
To install all of these in Fedora, run this command:
```
sudo dnf install wayland-devel wayland-protocols-devel hyprlang-devel pango-devel cairo-devel file-devel libglvnd-devel libglvnd-core-devel libjpeg-turbo-devel libwebp-devel gcc-c++ hyprutils-devel hyprwayland-scanner
```
On Arch:
```
sudo pacman -S ninja gcc wayland-protocols libjpeg-turbo libwebp pango cairo pkgconf cmake libglvnd wayland hyprutils hyprwayland-scanner hyprlang
```
On OpenSUSE:
```
sudo zypper install ninja gcc-c++ wayland-protocols-devel Mesa-libGLESv3-devel file-devel hyprutils-devel hyprwayland-scanner
```
### Building
Building is done via CMake:
```sh
cmake --no-warn-unused-cli -DCMAKE_BUILD_TYPE:STRING=Release -DCMAKE_INSTALL_PREFIX:PATH=/usr -S . -B ./build
cmake --build ./build --config Release --target hyprpaper -j`nproc 2>/dev/null || getconf _NPROCESSORS_CONF`
```
Install with:
```sh
cmake --install ./build
```
{{% /details %}}
## Configuration ## Configuration
The config file is located at `~/.config/hypr/hyprpaper.conf`. It is not The config file is located at `~/.config/hypr/hyprpaper.conf`. It is not
@ -41,6 +118,8 @@ Also you can use `reload` to unload preloaded image from your monitor(s),
preload another and set it to your monitor(s). It has the same syntax as preload another and set it to your monitor(s). It has the same syntax as
`wallpaper` keyword. `wallpaper` keyword.
### Run at startup
To run hyprpaper at startup edit `hyprland.conf` and add: `exec-once = To run hyprpaper at startup edit `hyprland.conf` and add: `exec-once =
hyprpaper`. hyprpaper`.