From 27362d8037c7a5e29b7f07e8fe423ab348f94381 Mon Sep 17 00:00:00 2001 From: Denis Lehmann Date: Sat, 12 Sep 2020 14:35:50 +0000 Subject: [PATCH] Update README --- README.org | 43 ++++++++++++++++++++----------------------- 1 file changed, 20 insertions(+), 23 deletions(-) diff --git a/README.org b/README.org index 13267ea..226b4b0 100644 --- a/README.org +++ b/README.org @@ -6,8 +6,8 @@ #+CAPTION: Logo [[./images/logo.png]] -*huepaper* creates wallpapers based on color hues. Bring a little color -in your life by randomness, because every huepaper is truly unique. +*huepaper* creates wallpapers based on color hues. +Bring a little color in your life by randomness, because every huepaper is truly unique. You can find [[#examples][examples]] below. @@ -23,8 +23,8 @@ Until now there is no install method, just ways to call the script. :CUSTOM_ID: nixos :END: -Call =nix-shell= in the project directory. This will drop you into a -python environment with all necessary requirements. +Call =nix-shell= in the project directory. +This will drop you into a python environment with all necessary requirements. *** LegacyOS :PROPERTIES: @@ -83,32 +83,30 @@ Install the python requirements with =pip install -r requirements.txt=. 0.9) #+END_EXAMPLE -All image operations are called in order of the help file. E.g. pixelate -(=-P=) is called after adding lines (=-l=). +All image operations are called in order of the help file. +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=, =red=. -Make sure, that colors beginning with a =#= are encapsulated in quotes -(="=). All supported color names can be seen +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=. +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]]. -If you use the =-e= argument to specify an emblem, make sure it has the -right size. It is not scaled or stretched, just placed in the center of -the image. If you want an offset, e.g. put it in the left bottom corner, -provide an emblem file with the size of the huepaper, transparent -background and your emblem in the bottom left corner. +If you use the =-e= argument to specify an emblem, make sure it has the correct size. +It is not scaled or stretched, just placed in the center of the image. +If you want an offset, e.g. put it in the left bottom corner, provide an emblem file with the size of the huepaper, transparent background and your emblem in the bottom left corner. ** Examples :PROPERTIES: :CUSTOM_ID: examples :END: -Please note, that every huepaper call generates a new random image. You -will never get the same huepaper twice. You may like some and dislike -others. Fiddle around with the options to find a result, you are happy -with. +Please note, that every huepaper call generates a new random image. +You will never get the same huepaper twice. +You may like some and dislike others. +Fiddle around with the options to find a result, you are happy with. #+CAPTION: Huepaper 1 [[./images/huepaper_1.png]] @@ -155,5 +153,4 @@ with. :CUSTOM_ID: acknowledgements :END: -Thanks to all the people who created the nice software, this project in -based on. +Thanks to all the people who created the nice software, this project is based on.