licence and readme

2016-09-27 13:05:09 +03:00
parent d250beabd9
commit 413fe9e4b5
2 changed files with 31 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -0,0 +1,18 @@
+# frozenbar
+
+A decently flexible script for lemonbar. In zsh.
+
+[A webm of it in action](https://8fw.me/hell/98a785e66a2e255559591516c29431f75a1a9a3a.webm)
+
+Main config file: $HOME/.config/frozenbar/rc  
+Default module paths: /usr/lib/frozenbar/mod and $HOME/.config/frozenbar/mod
+
+## Dependencies
+
+* lemonbar (duh)
+* xwininfo
+
+The example config is very bspwm-centric and additionally depends on:
+
+* bspwm
+* xdo