Compare commits

..

1 Commits

Author SHA1 Message Date
Maximilian P. Käfer 3815c2891f
Added proper content for the README.md 2021-05-18 19:33:34 +02:00
1 changed files with 34 additions and 3 deletions

View File

@ -29,7 +29,7 @@ $ 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.
Download the `PKGBUILD` file from this repository or from the paperchanger AUR site and move it to some folder.
Navigate into this folder using:
@ -44,7 +44,7 @@ $ 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.
This is your compressed ready to use paperchanger package, which can now be installed using `pacman`.
```shell
$ sudo pacman -U path-to-your-archive
@ -84,4 +84,35 @@ $ 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.
Paperchanger is now installed on your system, thus the folder you are in right now used for the installation might be deleted.
## Usage
Paperchanger has some flags that can be used.
A breef overview about the functionality can be accessed by looking into the help output:
```shell
$ paperchanger -h
or just
$p paperchanger
```
This will look something like this:
```shell
A tool to help change the wallpaper in a more comfortable way.
Uses xwallpaper to load the specified wallpaper.
Usage: paperchanger [OPTION] [PATH]
-h, --help, help Print this help.
-d, --display, display Display the specified wallpaper.
-s, --set, set Set the wallpaper with the path as parameter.
-S, --Set, Set Set the wallpaper with a graphical file chooser.
-ds, --display-and-set, display-and-set Set the wallpaper with an path as parameter AND display the specified wallpaper.
-dS, --display-and-Set, display-and-Set Set the wallpaper with a graphical file chooser AND display the specified wallpaper.
-p, --path, path Set the path of the default directory as parameter, where the file chooser to select a wallpaper is initially opened.
-P, --Path, Path Set the path of the default directory with a graphical file chooser, where the file chooser to select a file chooser is initially opened.
```
For further information about what every flag is doing, feel free to look into the `man` page for the package.