Add a simple READMEHEADmaster

1 files changed, 27 insertions, 0 deletions

diff --git a/README.org b/README.org
new file mode 100644
index 0000000..54bf46c
--- /dev/null
+++ b/README.org
@@ -0,0 +1,27 @@
+#+title: Pick Random Wallpaper
+#+options: toc:nil num:nil
+
+A simple script that searches through any number of image files and picks one at random to set as the current wallpaper.
+
+This script also tells [[https://herbstluftwm.org/][herbstluftwm]] what wallpaper it picked so that other scripts can work off of that.
+
+* Requirements
+
+This script requires [[https://scsh.net/][scsh]], [[https://www.gnu.org/software/findutils/][findutils]], [[https://www.x.org/wiki/][xwininfo]], [[https://feh.finalrewind.org/][feh]], and [[https://herbstluftwm.org/][herbstluftwm]].
+
+* Installation
+
+Put the =pick-random-wallpaper= script anywhere in your =$PATH=.
+
+* Usage
+
+Call the =pick-random-wallpaper= script without any arguments. It assumes that wallpapers are stored in =$HOME/pictures/wallpaper= under the resolution that they are for. It also looks at =$HOME/pictures/wallpaper/patterns/= for any tiled patterns. The hierarchy might look like:
+
+: ~/pictures/wallpaper/
+: |- 1024x768
+: | \- a.jpg
+: |- 5120x1440
+: | |- b.png
+: | \- sonic.jpg
+: \- patterns
+:   \- sandstone.png