summary refs log tree commit diff stats
path: root/README.org
diff options
context:
space:
mode:
authorAndinus <andinus@inventati.org>2020-03-14 16:23:53 +0530
committerAndinus <andinus@inventati.org>2020-03-14 16:23:53 +0530
commita7e66bc241524caf1accf02966c76f436fa19210 (patch)
tree8c8002b03ac1399ffe914e448de6c51f6777fab9 /README.org
parent6849d7fb2d78ee820978fa64cc3b6623dbf8d633 (diff)
downloadcetus-a7e66bc241524caf1accf02966c76f436fa19210.tar.gz
Split project into multiple programs
Re-initialization to split project into multiple programs
Diffstat (limited to 'README.org')
-rw-r--r--README.org31
1 files changed, 7 insertions, 24 deletions
diff --git a/README.org b/README.org
index 75678c5..9363c21 100644
--- a/README.org
+++ b/README.org
@@ -1,37 +1,20 @@
 #+TITLE: Cetus
 
-Cetus is a wallpaper manager written in Go. It uses [[https://source.unsplash.com/][Unsplash Source]] to get
-wallpapers.
+Cetus is a simple wallpaper management tool written in Go. It supports multiple
+sources for fetching the background.
 
 *Note*: Cetus is a work in-progress & many features are yet to be implemented.
 
-* Features
-- set a specific photo as background
-- set a random photo as background
-- customize wallpaper size
+*Dependency*: [[https://feh.finalrewind.org/][feh]]
+
 * Demo
 I just run some cetus commands on my computer, nothing fancy. I'll make better
 demo videos someday.
 
+*Note*: Cetus was restructured multiple times & these demos may not work on the
+latest release.
+
 | Version | Video                                                                |
 |---------+----------------------------------------------------------------------|
 | v0.3.1  | https://diode.zone/videos/watch/0808c512-315a-4dab-9526-4a537e8c3257 |
 | v0.2.0  | https://diode.zone/videos/watch/12db31e1-3517-4888-ad06-55f3859447a1 |
-* Dependency
-- [[https://feh.finalrewind.org/][feh]]
-* Usage
-** photo-id
-photo-id flag can be used to set a specific photo as background.
-#+BEGIN_SRC sh
-cetus -width 1920 -height 1080 \
-      -photo-id=FzrjgIId6NU
-#+END_SRC
-** random
-random flag can be used to set a random photo as background, this is the default
-behaviour.
-#+BEGIN_SRC sh
-cetus -width 1920 -height 1080 \
-      -random
-
-cetus -width 1920 -height 1080 # same as above
-#+END_SRC