aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorNathan Reiner <nathan@nathanreiner.xyz>2023-04-22 18:40:22 +0200
committerNathan Reiner <nathan@nathanreiner.xyz>2023-04-22 18:40:22 +0200
commitf14acf7306b022c1d0dd98f5fd654dbdc38e64e5 (patch)
tree562e30fdad694f11fc1075b353be6d22d9094171 /README.md
create ffbg
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..96cb61d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# ffbg - wayland wallpaper using farbfeld
+
+ffbg displays a ff pixmap centered of each monitor as wallpaper
+
+## Usage
+
+To display your wallpaper use:
+```sh
+cat /path/to/your/wallpaper.ff | ffbg
+```
+
+## Install
+
+To install use
+
+```sh
+make install
+```