aboutsummaryrefslogtreecommitdiffstats
path: root/README.rst
blob: 43e77956486afc398841cbe8343671fda0186487 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
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
===============
 yawa |travis|
===============

.. |travis| image:: https://img.shields.io/travis/yabok/yawa.svg?style=flat-square
   :alt: Travis Build Status
   :target: https://travis-ci.org/yabok/yawa

-----------------------------------
 Yet another wallpaper application
-----------------------------------

yawa is a now feature-complete fork of hsetroot, because there hasn't been
a release in over 10 years, because the upsteam website has been down for
years, and for one because I dislike how it handled option parsing.

So here is yawa with rewritten option parsing using glibc’s argp, all
warnings fixed and more argument checking, and hopefully also more
readable. (God I don’t know how upstream fucked the formating up so badly)


Dependencies
============

* glibc (argp argument parsing)
* imlib2
* libx11
* clang
* libbsd_ (strlcpy)
* sphinx (man page)

.. _libbsd: http://libbsd.freedesktop.org/


Building
========
::

    <git clone>
    mkdir yawa/build
    cd yawa/build
    cmake ..
    make
    sudo make install


Debugging
=========

When trying to debug yawa, run the `cmake` command with the
`-DCMAKE_BUILD_TYPE=DEBUG` arguments so that the binary is built with debug
symbols for meaningful backtraces.

License
=======

Every file in this repository, except for as otherwise specified in the file
itself or in this README if not possible, is licensed under version 2 of the
GNU GPL license