README.md 4.17 KB
Newer Older
GabMus's avatar
GabMus committed
1
# <a href="https://gabmus.gitlab.io/HydraPaper"><img height="32" src="data/icons/org.gabmus.hydrapaper.svg" /> HydraPaper</a>
GabMus's avatar
GabMus committed
2

GabMus's avatar
GabMus committed
3
Wallpaper manager with multimonitor support
GabMus's avatar
GabMus committed
4

GabMus's avatar
GabMus committed
5
![screenshot](website/screenshots/mainwindow.png)
GabMus's avatar
GabMus committed
6

7
## Installing
GabMus's avatar
GabMus committed
8

GabMus's avatar
GabMus committed
9
[![Packaging status](https://repology.org/badge/vertical-allrepos/hydrapaper.svg)](https://repology.org/project/hydrapaper/versions)
10

11
HydraPaper officially supports the following desktop environments:
12

13 14 15
- GNOME 3
- MATE
- Budgie
16

GabMus's avatar
GabMus committed
17
### Flatpak universal package
18

GabMus's avatar
GabMus committed
19
[Install **Flatpak** by following the quick setup guide](https://flatpak.org/setup/).
20 21 22

Click the following button install HydraPaper from the Flathub store.

23
[![Get it on Flathub](https://raw.githubusercontent.com/flatpak-design-team/flathub-mockups/master/assets/download-button/download.svg?sanitize=true)](https://flathub.org/apps/details/org.gabmus.hydrapaper)
24 25 26 27

### Installing on Arch Linux/Antergos/Manjaro

You can find HydraPaper on AUR, as `hydrapaper-git` ([AUR page](https://aur.archlinux.org/packages/hydrapaper-git)).
28

Artem's avatar
Artem committed
29 30 31 32
### Installing on Fedora

[Fedora (official repo)](https://apps.fedoraproject.org/packages/hydrapaper): `sudo dnf install hydrapaper`

33 34
### Other distros

GabMus's avatar
GabMus committed
35
Your best bet is installing via Flatpak. [Check the instructions in the Flatpak section](#flatpak-universal-package).
36 37 38 39 40

Alternatively ou can either run HydraPaper without installing it (refer to the [Building for testing section](#building-for-testing)), or install it in your system (refer to the [Installing systemwide directly section](#build-and-install-systemwide-directly)).

## Building

GabMus's avatar
GabMus committed
41 42 43 44 45 46 47 48
HydraPaper has these dependencies:

- `python3` (>=3.5)
- `python-pillow`
- `libwnck3`
- `libhandy` (>=0.10)
- `gtk`

49 50 51 52 53 54 55
### Building for testing

This is the best practice to test HydraPaper without installing using meson and ninja.

#### First time

```bash
56
git clone https://gitlab.com/gabmus/hydrapaper
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
cd hydrapaper
mkdir builddir
cd builddir
meson ..
meson configure -Dprefix=$(pwd)/testdir
ninja install # This will actually install in hydrapaper/builddir/testdir
ninja run
```

#### Later on

```bash
cd hydrapaper/builddir
ninja install # This will actually install in hydrapaper/builddir/testdir
ninja run
```

74
### Building a Flatpak
75

GabMus's avatar
GabMus committed
76 77
*NOTE: these instructions could be out of date. Please use GNOME Builder to build and test Flatpaks easily.*

78 79 80 81
First install `flatpak` and `flatpak-builder` from your distro repository. Although it's not necessary, you may also want to install `gnome-software`.

Create a directory somewhere in your home, I suggest something like `~/hydrapaperflatpak`.

82
Either clone the whole HydraPaper repo (`git clone https://gitlab.com/gabmus/hydrapaper`) or just download the flatpak manifest file from this repo in `dist/flatpak/org.gabmus.hydrapaper.json`. In either case, put the files inside the directory you created before.
83 84 85 86 87 88 89 90 91

Run the following: `flatpak-builder --repo=repo hydrapaper $PATH_TO_MANIFEST` where `$PATH_TO_MANIFEST` is the path to the `org.gabmus.hydrapaper.json` flatpak manifest. If everything works correctly, this command should create two directories `repo` and `hydrapaper` with flatpak stuff inside of your present working directory (again, I suggest to run everything inside a specifically designated directory).

Now you'll be creating a flatpak bundle, so that you can install it and distribute it without messing with flatpak repos. To do this you run `flatpak build-bundle repo hydrapaper.flatpak org.gabmus.hydrapaper`. This will give you a hydrapaper.flatpak file inside your present working directory. To install it, either open it with `gnome-software` or run `flatpak install hydrapaper.flatpak`.

*Note: I am a just a beginner with flatpak, and probably some of the instructions I gave in this section of the readme are wrong or could be done better. If you know a better way of doing this, please don't hesitate to make a pull request or open an issue.*

### Build and install systemwide directly

92
**WARNING**: This approach is discouraged, since it will manually copy all the files in your system. **Uninstalling could be difficult and/or dangerous**.
93 94 95 96

But if you know what you're doing, here you go:

```bash
97
git clone https://gitlab.com/gabmus/hydrapaper
98 99 100 101 102 103
cd hydrapaper
mkdir builddir
cd builddir
meson ..
ninja install
```