Commit faa93477c02bc79d0e86bac34861df4b5c4ab0bc
Parent: 5d094c147d5ee0203b5c8a439f896956406d1647
Author: mcol <mcol@posteo.net>
Date: 2020-01-11 13:35:46 +0000
Committer: mcol <mcol@posteo.net>
Committed: 2020-01-11 13:35:46 +0000

add readme

readme.rst Added

@@ -0,0 +1,53 @@
+qtools
+======
+
+This is a small collection of plugins I wrote for Qtile_.
+
+Aims:
+    - Simplifying Qtile configuration.
+    - Only loading those that are used.
+    - Ability to easily create responsive key-bindings with notifications.
+    - Avoiding extra dependencies.
+
+
+Notifiers
+---------
+
+:code:`Notifier`-based plugins expose methods that trigger notifications, with
+the purpose of being bound to keys.
+
+An example usage:
+
+.. code-block:: python
+
+    import qtools.mpc
+    mpc = qtools.mpc.Client()
+    keys.extend([EzKey(k, v) for k, v in {
+        '<XF86AudioPlay>':  mpc.lazy_toggle,
+        '<XF86AudioNext>':  mpc.lazy_next,
+        '<XF86AudioPrev>':  mpc.lazy_previous,
+    }.items()])
+
+:code:`Notifier`'s methods are exposed with the 'lazy\_' prefix for binding to
+keys.
+
+:code:`qtools.mpc.Client` is a subclass of :code:`Notifier`, which is found at
+:code:`qtools.Notifier` in :code:`qtools/__init__.py`.
+
+
+Plugin list
+-----------
+
+==============  ===============================================================
+Module          Description
+==============  ===============================================================
+amixer          Notifier that controls an ALSA device's volume
+
+backlight       Notifier that controls backlight level
+
+mpc             Notifier that controls MPD
+
+xresources      Load X resources into Qtile config
+==============  ===============================================================
+
+.. _Qtile: https://github.com/qtile/qtile