From d5e565c68e6f5b51690378710228597fcaa8eb9b Mon Sep 17 00:00:00 2001
From: Denis Lehmann <denis@opaque.tech>
Date: Sun, 13 Sep 2020 15:33:20 +0200
Subject: [PATCH] Update README

---
 README.org | 52 ++++++++++++++++++++--------------------------------
 1 file changed, 20 insertions(+), 32 deletions(-)

diff --git a/README.org b/README.org
index 226b4b0..3a66a70 100644
--- a/README.org
+++ b/README.org
@@ -11,6 +11,8 @@ Bring a little color in your life by randomness, because every huepaper is truly
 
 You can find [[#examples][examples]] below.
 
+The literate programming file can be found in [[./huepaper.org][huepaper.org]].
+
 ** Installation
    :PROPERTIES:
    :CUSTOM_ID: installation
@@ -39,48 +41,34 @@ Install the python requirements with =pip install -r requirements.txt=.
    :END:
 
 #+BEGIN_EXAMPLE
-  usage: huepaper.py [-h] [-W WIDTH] [-H HEIGHT] [-c COLOR] [-p] [-o OUTPUT]
-  [-l [LINES]] [-lb [LINES_BRIGHT]] [-ld [LINES_DARK]]
-  [-P PIXELATE] [-e EMBLEM] [-hue HUE] [-smin SMIN]
-  [-smax SMAX] [-lmin LMIN] [-lmax LMAX]
+  usage: huepaper.py [-h] [-s SIZE] [-c COLOR] [-p] [-o OUTPUT] [-l [LINES]] [-lb [LINES_BRIGHT]] [-ld [LINES_DARK]]
+                     [-P [PIXELATE]] [-e EMBLEM] [-hue HUE] [-smin SMIN] [-smax SMAX] [-lmin LMIN] [-lmax LMAX]
 
   Create wallpapers based on color hues.
 
   optional arguments:
     -h, --help            show this help message and exit
-    -W WIDTH, --width WIDTH
-                          width of wallpaper (defaul: 1920)
-    -H HEIGHT, --height HEIGHT
-                          height of wallpaper (default: 1080)
+    -s SIZE, --size SIZE  size of huepaper in the form WIDTHxHEIGHT (default: 1920x1080)
     -c COLOR, --color COLOR
-                          color, the wallpaper is generated from (uses a random
-                          color if not given)
-    -p, --preview         preview wallpaper
+                          color, the huepaper is generated from (uses a random color if not given)
+    -p, --preview         preview huepaper
     -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]
-                          include one to three random lines in base color with
-                          given opacity in range [0, 1] (default: 0.1)
+                          include one to three random lines in base color with given opacity in range [0, 1] (default: 0.3)
     -lb [LINES_BRIGHT], --lines_bright [LINES_BRIGHT]
-                          include one to three bright random lines with given
-                          opacity in range [0, 1] (default: 0.1)
+                          include one to three bright random lines with given opacity in range [0, 1] (default: 0.1)
     -ld [LINES_DARK], --lines_dark [LINES_DARK]
-                          include one to three dark random lines with given
-                          opacity in range [0, 1] (default: 0.1)
-    -P PIXELATE, --pixelate PIXELATE
-                          pixelate image (e.g. 42x42)
+                          include one to three dark random lines with given opacity in range [0, 1] (default: 0.1)
+    -P [PIXELATE], --pixelate [PIXELATE]
+                          pixelate image with WIDTHxHEIGHT (default: 16x9)
     -e EMBLEM, --emblem EMBLEM
-                          emblem to add in the center of the wallpaper
-    -hue HUE              maximum hue to differ from given color in range [0, 1]
-                          (default: 0.1)
-    -smin SMIN            minimum satisfaction for colors in range [0, 1]
-                          (default: 0.2)
-    -smax SMAX            maximum satisfaction for colors in range [0, 1]
-                          (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)
+                          emblem to add in the center of the huepaper
+    -hue HUE              maximum hue to differ from given color in range [0, 1] (default: 0.1)
+    -smin SMIN            minimum satisfaction for colors in range [0, 1] (default: 0.2)
+    -smax SMAX            maximum satisfaction for colors in range [0, 1] (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
 
 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.
 Colors, similar to the given one are chosen.
 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 (="=).
 All supported color names can be seen
 [[https://www.w3schools.com/colors/colors_names.asp][here]].