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-12 14:35:50 +00:00
parent a385dec6e2
commit 27362d8037
1 changed files with 20 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
README.org
View File

@ -6,8 +6,8 @@
#+CAPTION: Logo #+CAPTION: Logo
[[./images/logo.png]] [[./images/logo.png]]
*huepaper* creates wallpapers based on color hues. Bring a little color *huepaper* creates wallpapers based on color hues.
in your life by randomness, because every huepaper is truly unique. Bring a little color in your life by randomness, because every huepaper is truly unique.
You can find [[#examples][examples]] below. 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 :CUSTOM_ID: nixos
:END: :END:
Call =nix-shell= in the project directory. This will drop you into a Call =nix-shell= in the project directory.
python environment with all necessary requirements. This will drop you into a python environment with all necessary requirements.
*** LegacyOS *** LegacyOS
:PROPERTIES: :PROPERTIES:
@ -83,32 +83,30 @@ Install the python requirements with =pip install -r requirements.txt=.
0.9) 0.9)
#+END_EXAMPLE #+END_EXAMPLE
All image operations are called in order of the help file. E.g. pixelate All image operations are called in order of the help file.
(=-P=) is called after adding lines (=-l=). 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 If you set the color via =-c= it is not guaranteed, that it is included in the huepaper.
in the huepaper. Colors, similar to the given one are chosen. You can Colors, similar to the given one are chosen.
specify how far the colors differ in the hue range with the =-hue= You can specify how far the colors differ in the hue range with the =-hue= parameter.
parameter. Valid color expressions are e.g. =#F5F5DC=, =#0f0=, =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]].
If you use the =-e= argument to specify an emblem, make sure it has the If you use the =-e= argument to specify an emblem, make sure it has the correct size.
right size. It is not scaled or stretched, just placed in the center of It is not scaled or stretched, just placed in the center of the image.
the image. If you want an offset, e.g. put it in the left bottom corner, 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.
provide an emblem file with the size of the huepaper, transparent
background and your emblem in the bottom left corner.
** Examples ** Examples
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: examples :CUSTOM_ID: examples
:END: :END:
Please note, that every huepaper call generates a new random image. You Please note, that every huepaper call generates a new random image.
will never get the same huepaper twice. You may like some and dislike You will never get the same huepaper twice.
others. Fiddle around with the options to find a result, you are happy You may like some and dislike others.
with. Fiddle around with the options to find a result, you are happy with.
#+CAPTION: Huepaper 1 #+CAPTION: Huepaper 1
[[./images/huepaper_1.png]] [[./images/huepaper_1.png]]
@ -155,5 +153,4 @@ with.
:CUSTOM_ID: acknowledgements :CUSTOM_ID: acknowledgements
:END: :END:
Thanks to all the people who created the nice software, this project in Thanks to all the people who created the nice software, this project is based on.
based on.