From b1756027ed46ff1232845504a877dde38562f6e2 Mon Sep 17 00:00:00 2001
From: Pavel Makhov <pmakhov@touchtunes.com>
Date: Wed, 13 Feb 2019 11:43:57 -0500
Subject: brightnessarc widget

---
 brightnessarc-widget/README.md | 56 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 56 insertions(+)
 create mode 100644 brightnessarc-widget/README.md

(limited to 'brightnessarc-widget/README.md')

diff --git a/brightnessarc-widget/README.md b/brightnessarc-widget/README.md
new file mode 100644
index 0000000..fa123c1
--- /dev/null
+++ b/brightnessarc-widget/README.md
@@ -0,0 +1,56 @@
+# Brightness widget
+
+![Brightness widget](./br-wid-1.png)
+
+This widget represents current brightness level.
+
+## Installation
+
+Firstly you need to get the current brightness level. There are two options:
+
+ - using `xbacklight` command (depending on your video card (I guess) it may or may not work)
+ 
+    To check if it works install xbackligth and check if it works:
+ 
+    ```bash
+    sudo apt-get install xbacklight
+    xbacklight -get
+    ```
+
+    If there is no output it means that it doesn't work, but there is a second option:
+
+ - using `light` command
+ 
+    Install it from this git repo: [github.com/haikarainen/light](https://github.com/haikarainen/light) and check if it works but running
+
+    ```bash
+    git clone https://github.com/haikarainen/light.git && \
+    cd ./light && \
+    sudo make && sudo make install \
+    light -G
+    49.18
+    ```
+Depending on the chosen option change `GET_BRIGHTNESS_CMD` variable in **brightness.lua**.
+
+Then in **rc.lua** add the import on top of the file and then add widget to the wibox:
+
+```lua
+require("awesome-wm-widgets.brightness-widget.brightness")
+...
+-- Add widgets to the wibox
+s.mywibox:setup {
+...
+{ -- Right widgets
+...
+brightness_widget
+```
+
+## Controls
+
+In order to change brightness by shortcuts you can add them to the `globalkeys` table in the **rc.lua**:
+
+```lua
+awful.key({ modkey         }, ";", function () awful.spawn("light -A 5") end, {description = "increase brightness", group = "custom"}),
+awful.key({ modkey, "Shift"}, ";", function () awful.spawn("light -U 5") end, {description = "decrease brightness", group = "custom"}),
+```
+On laptop you can use `XF86MonBrightnessUp` and `XF86MonBrightnessDown` keys.
-- 
cgit v1.2.3