profitroll/huepaper
profitroll/huepaper
1
0
Fork 0
Code Issues Pull Requests Actions Packages Releases 3 Activity

Update README

Browse Source
This commit is contained in:
Denis Lehmann 2020-09-13 15:33:20 +02:00
parent 25d0469db1
commit d5e565c68e
1 changed files with 20 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
README.org
View File

@ -11,6 +11,8 @@ Bring a little color in your life by randomness, because every huepaper is truly
You can find [[#examples][examples]] below. You can find [[#examples][examples]] below.
The literate programming file can be found in [[./huepaper.org][huepaper.org]].
** Installation ** Installation
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: installation :CUSTOM_ID: installation
@ -39,48 +41,34 @@ Install the python requirements with =pip install -r requirements.txt=.
:END: :END:
#+BEGIN_EXAMPLE #+BEGIN_EXAMPLE
usage: huepaper.py [-h] [-W WIDTH] [-H HEIGHT] [-c COLOR] [-p] [-o OUTPUT] usage: huepaper.py [-h] [-s SIZE] [-c COLOR] [-p] [-o OUTPUT] [-l [LINES]] [-lb [LINES_BRIGHT]] [-ld [LINES_DARK]]
[-l [LINES]] [-lb [LINES_BRIGHT]] [-ld [LINES_DARK]] [-P [PIXELATE]] [-e EMBLEM] [-hue HUE] [-smin SMIN] [-smax SMAX] [-lmin LMIN] [-lmax LMAX]
[-P PIXELATE] [-e EMBLEM] [-hue HUE] [-smin SMIN]
[-smax SMAX] [-lmin LMIN] [-lmax LMAX]
Create wallpapers based on color hues. Create wallpapers based on color hues.
optional arguments: optional arguments:
-h, --help show this help message and exit -h, --help show this help message and exit
-W WIDTH, --width WIDTH -s SIZE, --size SIZE size of huepaper in the form WIDTHxHEIGHT (default: 1920x1080)
width of wallpaper (defaul: 1920)
-H HEIGHT, --height HEIGHT
height of wallpaper (default: 1080)
-c COLOR, --color COLOR -c COLOR, --color COLOR
color, the wallpaper is generated from (uses a random color, the huepaper is generated from (uses a random color if not given)
color if not given) -p, --preview preview huepaper
-p, --preview preview wallpaper
-o OUTPUT, --output OUTPUT -o OUTPUT, --output OUTPUT
file where to save the wallpaper to (default: None) file where to save the huepaper to (default: None)
-l [LINES], --lines [LINES] -l [LINES], --lines [LINES]
include one to three random lines in base color with include one to three random lines in base color with given opacity in range [0, 1] (default: 0.3)
given opacity in range [0, 1] (default: 0.1)
-lb [LINES_BRIGHT], --lines_bright [LINES_BRIGHT] -lb [LINES_BRIGHT], --lines_bright [LINES_BRIGHT]
include one to three bright random lines with given include one to three bright random lines with given opacity in range [0, 1] (default: 0.1)
opacity in range [0, 1] (default: 0.1)
-ld [LINES_DARK], --lines_dark [LINES_DARK] -ld [LINES_DARK], --lines_dark [LINES_DARK]
include one to three dark random lines with given include one to three dark random lines with given opacity in range [0, 1] (default: 0.1)
opacity in range [0, 1] (default: 0.1) -P [PIXELATE], --pixelate [PIXELATE]
-P PIXELATE, --pixelate PIXELATE pixelate image with WIDTHxHEIGHT (default: 16x9)
pixelate image (e.g. 42x42)
-e EMBLEM, --emblem EMBLEM -e EMBLEM, --emblem EMBLEM
emblem to add in the center of the wallpaper emblem to add in the center of the huepaper
-hue HUE maximum hue to differ from given color in range [0, 1] -hue HUE maximum hue to differ from given color in range [0, 1] (default: 0.1)
(default: 0.1) -smin SMIN minimum satisfaction for colors in range [0, 1] (default: 0.2)
-smin SMIN minimum satisfaction for colors in range [0, 1] -smax SMAX maximum satisfaction for colors in range [0, 1] (default: 1.0)
(default: 0.2) -lmin LMIN minimum luminance for colors in range [0, 1] (default: 0.2)
-smax SMAX maximum satisfaction for colors in range [0, 1] -lmax LMAX maximum luminance for colors in range [0, 1] (default: 0.9)
(default: 1.0)
-lmin LMIN minimum luminance for colors in range [0, 1] (default:
0.2)
-lmax LMAX maximum luminance for colors in range [0, 1] (default:
0.9)
#+END_EXAMPLE #+END_EXAMPLE
All image operations are called in order of the help file. All image operations are called in order of the help file.
@ -89,7 +77,7 @@ E.g. pixelate (=-P=) is called after adding lines (=-l=).
If you set the color via =-c= it is not guaranteed, that it is included in the huepaper. If you set the color via =-c= it is not guaranteed, that it is included in the huepaper.
Colors, similar to the given one are chosen. Colors, similar to the given one are chosen.
You can specify how far the colors differ in the hue range with the =-hue= parameter. You can specify how far the colors differ in the hue range with the =-hue= parameter.
Valid color expressions are e.g. =#F5F5DC=, =#0f0= and =red=. Valid color expressions are e.g. =#F5F5DC=, =#0f0= and =red=.
Make sure, that colors beginning with a =#= are encapsulated in quotes (="=). Make sure, that colors beginning with a =#= are encapsulated in quotes (="=).
All supported color names can be seen All supported color names can be seen
[[https://www.w3schools.com/colors/colors_names.asp][here]]. [[https://www.w3schools.com/colors/colors_names.asp][here]].