From 09623655adc5a3a4d9de56383f6ca8392978b518 Mon Sep 17 00:00:00 2001 From: Andinus Date: Thu, 12 Mar 2020 16:27:58 +0530 Subject: Restructure readme --- README.org | 58 +++++++++++++++++++++++++++++----------------------------- 1 file changed, 29 insertions(+), 29 deletions(-) (limited to 'README.org') diff --git a/README.org b/README.org index 3aee07f..f65a565 100644 --- a/README.org +++ b/README.org @@ -3,30 +3,9 @@ Cetus is a wallpaper tool written in Go. It can set wallpapers from various sources. Default behaviour is to set a random wallpaper. -* Defaults -| flag | var | default | -|------+------+-------------------------------------------| -| wall | wall | random (daily when random is unavailable) | -| src | src | random | - -Currently only Unsplash Source random is supported for width, height -| width | width | 1920 | -| height | height | 1080 | -** Astronomy Picture of the Day -| flag | var | default | -|--------------+------------+-------------------------------------| -| apod-api | apodAPI | https://api.nasa.gov/planetary/apod | -| apod-api-key | apodAPIKey | DEMO_KEY | -| wall | wall | daily | -** Bing Photo of the Day -| flag | var | default | -|----------+---------+------------------------------------------| -| bpod-api | bpodAPI | https://www.bing.com/HPImageArchive.aspx | -| bpod-num | bpodNum | 16 | -** Unsplash Source -| flag | var | default | -|--------------+-------------+-----------------------------| -| unsplash-api | unsplashAPI | https://source.unsplash.com | +* Uses +- on system startup for new wallpaper at every startup +- as a cron job to change wallpaper at set intervals * Demo I just run some cetus commands on my computer, nothing fancy. I'll make better demo videos someday. @@ -34,11 +13,11 @@ demo videos someday. | Version | Video | |---------+----------------------------------------------------------------------| | v0.2.0 | https://diode.zone/videos/watch/12db31e1-3517-4888-ad06-55f3859447a1 | -* Dependency -- [[https://feh.finalrewind.org/][feh]] * Features - Set Daily, Weekly or Random wallpaper - Supports multiple sources +* Dependency +- [[https://feh.finalrewind.org/][feh]] * Examples ** Daily wallpaper *** from Astronomy Picture of the Day @@ -83,6 +62,27 @@ cetus -src=random -wall=random cetus # This is same as above #+END_SRC -* Uses -- on system startup for new wallpaper at every startup -- as a cron job to change wallpaper at set intervals +* Defaults +| flag | var | default | +|------+------+-------------------------------------------| +| wall | wall | random (daily when random is unavailable) | +| src | src | random | + +Currently only Unsplash Source random is supported for width, height +| width | width | 1920 | +| height | height | 1080 | +** Astronomy Picture of the Day +| flag | var | default | +|--------------+------------+-------------------------------------| +| apod-api | apodAPI | https://api.nasa.gov/planetary/apod | +| apod-api-key | apodAPIKey | DEMO_KEY | +| wall | wall | daily | +** Bing Photo of the Day +| flag | var | default | +|----------+---------+------------------------------------------| +| bpod-api | bpodAPI | https://www.bing.com/HPImageArchive.aspx | +| bpod-num | bpodNum | 16 | +** Unsplash Source +| flag | var | default | +|--------------+-------------+-----------------------------| +| unsplash-api | unsplashAPI | https://source.unsplash.com | -- cgit 1.4.1-2-gfad0 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115