added README.md

oen9 · Feb 28, 2020 · 6dd843b · 6dd843b
1 parent 4a9d6ae
commit 6dd843b
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,25 @@
 # tray-backlight-control
+
 Tray backlight control for linux
+
+## how to use
+
+Add `tray-backlight-control` to autostart and just use it.\
+tray icon: ![alt text](https://raw.githubusercontent.com/oen9/tray-backlight-control/master/src/main/resources/bulb14.png "tray icon")\
+![alt text](https://raw.githubusercontent.com/oen9/tray-backlight-control/master/img/popup.png "popup")
+
+## system dependencies
+
+- `xbacklight` (or replacement like [acpilight](https://gitlab.com/wavexx/acpilight/ "acpilight"))
+- `java` (tested with `java version "11.0.2"`)
+
+## sources
+
+### howto compile
+
+1. compile: `sbt stage`
+1. run: `./target/universal/stage/bin/tray-backlight-control`
+
+### libraries
+
+1. ZIO
diff --git a/img/popup.png b/img/popup.png