Compare commits

...

1 Commits

Author SHA1 Message Date
Maximilian P. Käfer 8480eed885
Added proper content for the README.md 2021-05-17 23:24:19 +02:00
1 changed files with 49 additions and 0 deletions

View File

@ -1,3 +1,52 @@
# Paperchanger
## Introduction
`Paperchanger` is a program aimed to assist one using the `xwallpaper` tool.
Hence `xwallpaper` provides no comprehensive way of changing the wallpaper through a graphical selector, `paperchanger` is there to fix this flaw.
Of course `paperchanger` offers fuctionality to change the wallpaper by passing a path to a file, just like you would with `xwallpaper`.
Additionally, `paperchanger` gives you the option of specifying a default directory where all your wallpapers are stored.
This is nice, as it provides an easier workflow for changing wallpapers.
It is important to know that `paperchanger` is using the `--zoom` flag provided by `xwallpaper` internally, although this might be adjusted or extended at some point in the future.
## Installation
### Arch Based Systems
If you are using an arch based system, you can install the `paperchanger` package from the [AUR](https://aur.archlinux.org/) (Arch User Repository).
(Not yet available!)
An AUR manager like yay may be used for an easy installation:
```shell
$ yay -S paperchanger
```
If you do not want to use an AUR manager, here is how to compile and install the package manually:
Download the `PKGBUILD` file from this repository and move it to some folder.
Navigate into this folder using:
```shell
$ cd path-to-the-folder
```
Now use the `makepkg` command to download the source files and compile the package:
```shell
$ makepkg
```
After you are done creating the package, you should have many files including a `.pkg.tar.zst` archive.
This is your compressed ready to use `paperchanger` package, which can now be installed using pacman.
```shell
$ sudo pacman -U path-to-your-archive
```
The folder and its contents used for the installation process may now be deleted.
### Other Systems (PKGBUILD file is not used)
Insert description here.