Compare commits

..

1 Commits

Author SHA1 Message Date
Maximilian P. Käfer 9b729a3161
Added proper content for the README.md 2021-05-18 19:20:52 +02:00
1 changed files with 40 additions and 5 deletions

View File

@ -3,18 +3,20 @@
## 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`.
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.
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.
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
#### With an AUR Manager
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!)
@ -23,6 +25,8 @@ An AUR manager like `yay` may be used for an easy installation:
```shell
$ yay -S paperchanger
```
#### Without an AUR manager
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.
@ -49,4 +53,35 @@ $ 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.
A `dpkg-buildpackage` file might be added at some point, but for now the installation must be done manually.
Make sure `git` is installed on your system.
First clone the source files from this git repository:
```shell
$ git clone https://git.kske.dev/DieGurke/paperchanger.git
```
Navigate into the folder using:
```shell
$ cd paperchanger/
```
Now copy the shell script into the `/usr/bin/` folder on your system:
```shell
$ sudo cp paperchanger.sh /usr/bin/paperchanger
```
Now the `README.md` and the `LICENSE` files have to be copied to the appropriate folders on your system:
```shell
$ sudo mkdir /usr/share/doc/paperchanger
$ sudo cp README.md /usr/share/doc/paperchanger/README.md
$ sudo mkdir /usr/share/licenses/paperchanger
$ sudo cp LICENSE /usr/share/licenses/paperchanger/LICENSE
```
Paperchanger is now installed on your system, thus the folder you are in right now used for installation might be deleted.