From e4d92e8927732434bc73aba00c577002c01c7d5a Mon Sep 17 00:00:00 2001
From: Roland Schneider <rocho02@gmail.com>
Date: Sun, 30 Jan 2022 09:39:09 +0100
Subject: [PATCH] improve doc

---
 install-deps.sh |  3 ++-
 rc.lua          |  2 +-
 readme.md       | 34 ++++++++++++++++++++++++++++++++++
 3 files changed, 37 insertions(+), 2 deletions(-)
 create mode 100644 readme.md

diff --git a/install-deps.sh b/install-deps.sh
index 5257686..926bd87 100644
--- a/install-deps.sh
+++ b/install-deps.sh
@@ -2,4 +2,5 @@ git clone https://github.com/deficient/battery-widget.git
 git clone https://github.com/deficient/keyboard-layout-indicator.git
 git clone https://github.com/guotsuan/awesome-revelation revelation
 git clone https://github.com/berlam/awesome-switcher.git awesome-switcher
-sudo apt-get install acpid
+sudo apt update
+sudo apt-get install acpid fonts-emojione fonts-noto-color-emoji
diff --git a/rc.lua b/rc.lua
index ecd5d3f..f9ce70f 100644
--- a/rc.lua
+++ b/rc.lua
@@ -994,5 +994,5 @@ client.connect_signal("unfocus", function(c) c.border_color = beautiful.border_n
 -- }}}
 --
 -- {{{ autostart
--- awful.spawn.with_shell("~/.config/awesome/autorun.sh")
+ awful.spawn.with_shell("~/.config/awesome/autorun.sh")
 -- }}}
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..c2f9cf9
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,34 @@
+# AwesomeWM config
+
+Features:
+- fix set of tags 1-20 (super+num|super+numpad)
+- tags can be moved across multiple screen  (super+num|super+numpad)
+- move client to tag (super+shift+num|super+shift+numpad)
+- revelation widget (super+e)
+- battery-widget
+- keyboard-layout-indicator
+- awesome-switcher(alt+tab)
+
+Main keyboard shortcuts
+
+select next client in current tag: super u, super i
+restore all clients in current tag: super o
+minimize/open client: super+n
+maximaze client: super+m
+revelation plugin: super+e
+show help: super+s
+select tag 1-10: super+num
+select tag 11-20: super+numpad
+next/prev tag: super+arrow(left|right)
+select client by index: super+alt+num
+
+
+## Checkout
+
+Checkout the awesome folder and copy it to
+~/.cofig/awesome
+
+## install dependencies
+```bash
+sudo bash install-deps.sh
+```