From 9b729a3161e29e91fd34250fd6d955b36e9b70e5 Mon Sep 17 00:00:00 2001
From: DieGurke <maxi@kske.dev>
Date: Mon, 17 May 2021 23:13:25 +0200
Subject: [PATCH] Added proper content for the README.md

---
 README.md | 86 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 85 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 80597ff..b9e7ac6 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,87 @@
 # Paperchanger
 
-Insert description here.
+## 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
+
+#### 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!)
+
+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.
+
+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)
+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.