From b7f877c1cc5f81414ef8a1b12dddbf0e81c06b8e Mon Sep 17 00:00:00 2001 From: bimlas Date: Fri, 10 Apr 2020 21:58:05 +0200 Subject: [PATCH] Add readme --- README.adoc | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 README.adoc diff --git a/README.adoc b/README.adoc new file mode 100644 index 0000000..dc905df --- /dev/null +++ b/README.adoc @@ -0,0 +1,47 @@ += XFCE Night Mode + +Shell script that allows you to easily *switch between dark and light variants +of a theme*. When used as a +https://docs.xfce.org/panel-plugins/xfce4-genmon-plugin[Generic Monitor +(Genmon)] plugin, it will automatically switch at the times specified. + +video::https://i.imgur.com/hnPtVPr.mp4[width=400] + +It is *important that both the color scheme and the icon theme have both light +and dark variants*. For example, the Adwaita and Adwaita-dark GTK style and +the Elementary and Elementary-dark icon theme are such. + +* https://gitlab.com/bimlas/xfce4-night-mode (main repository) +* https://github.com/bimlas/xfce4-night-mode (mirror, *please star if you like the plugin*) + +== Command line usage + +.... +$ xfce4-night-mode.sh [day|night|toggle] +.... + +*Parameters* + +`day`:: Use light variant +`night`:: Use dark variant +`toggle`:: Switch between light and dark variants + +Without parameters, it will use dark variant from sunset to sunrise according +to the settings (see later). + +== Generic Monitor (Genmon) plugin usage + +* First you have to install `xfce4-genmon-plugin` package if it is not on your system +* Add the monitor to the panel +** Right click on the panel +** Select _Panel -> Add new items_ +** Add _Generic Monitor_ plugin +* Set up the generic monitor to use with night mode +** Right click on the newly added generic monitor -> _Properties_ +** Command: `/path/to/xfce4-night-mode.sh` +** Uncheck the checkbox of _Label_ +** Set _Period_ to `300` seconds (5 minutes) + +== Settings + +For settings, open the XFCE Settings Editor -> `night-mode` channel.