Copyright and license
----------------------

Copyright (C) 2019-2020 Michał Bąbik

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.


CONTENTS OF THIS FILE
----------------------

 * Copyright and license
 * Contents of this file
 * About
 * Requirements
 * Installation and running
 * Contact and help


About
------

Wall Changer is an automatic wallpaper changer.
User can select images that will be used as wallpapers,
select command to set wallpaper, wallpaper change time interval.

Program works in GNU/Linux, FreeBSD.


Requirements
-------------

 * GNU/Linux, FreeBSD
 * GCC / Clang
 * json-c (>= 0.12.1)
 * GTK+ 3 (>= 3.22)


Installation and running
-------------------------

For installation instructions see INSTALL file.

If compilation ends without problems, 2 executable files will be created:

    wchangerd
    wchangercfg

wchangerd works in background and changes wallpaper in specified time intervals.

wchangercfg is a configuration window to set wallpaper change time intervals,
images on wallpaper list, the way wallpapers change, etc. 

working with the wchangerd daemon:

    wchangerd --start      Starts the wchangerd daemon
    wchangerd --stop       Stops the wchangerd daemon
    wchangerd --restart    Restarts the wchangerd daemon

    wchangerd --once       Change wallpaper once and exit

    wchangerd --config     Loads configuration from given file

The wallpaper change command is selected based on the currently used window
manager.
Application has default wallpaper change commands for several window managers.
Default commands can be changed througn wchangercfg, using Select button.
It opens wallpaper command set dialog with list of window managers and commands.
After checking and setting commands, especially for Xfce, which has an unusual
wallpaper set command, you can use this app with different window managers
without changing settings.

Afer changing settings using wchangercfg, wchangerd daemon will load them before
next wallpaper change. If you want to load settings before that time, you need
to restart wchangerd daemon using wchangerd --restart command. 

Default places for configuration file:
(application will look for it in order like on the list below)

    ~/.config/wchanger/config.json
    ~/.config/wchanger.json
    ~/.config/wchanger/wchanger.json

To use other than standard config path, use the --config option:

    wchangerd --config [FILENAME]
    wchangercfg --config [FILENAME]


Contact and help
-----------------

In case of problems with the program, please contact me:
michal.babik@pm.me

