From 1cd3b1f593c875c621e3982dd2c5a25178247d27 Mon Sep 17 00:00:00 2001 From: Kievits Rene Date: Mon, 18 Apr 2022 15:46:25 +0200 Subject: [PATCH] update readme --- .vscode/settings.json | 3 ++- README.md | 37 ++++++++++++++++++++++++++++++++----- 2 files changed, 34 insertions(+), 6 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index 9b0ef91..589b6c6 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -6,6 +6,7 @@ "awesome", "client", "screen", - "mouse" + "mouse", + "double_click_timer" ] } diff --git a/README.md b/README.md index 2be2d50..2733b54 100644 --- a/README.md +++ b/README.md @@ -13,14 +13,15 @@ If you feel lost, got a problem or just have a question, please check out the wi --- -Installing my theme is rather easy, just copy the repo and put the awesome folder to ~/.config/ -But in order for it to work as seen you need some dependencies installed along the way +### [Installation]() + +Installing this theme is rather easy, just copy the repo and put the awesome folder to ~/.config/ +But in order for it to work as seen you need some dependencies installed along the way. Here are the main components, but in order for everything to work go [here](). ||Arch|Ubuntu|Why?| |:-:|:-:|:-:|:-:| -|Command|sudo pacman -S ( yay -S for aur )|sudo apt install|| -|AwesomeWM|awesome|awesome|Its your Window Manager lol| -|Rofi|rofi|rofi|For the application launcher| +|AwesomeWM|awesome|[Guide here]()|Its your Window Manager lol| +|Rofi|rofi|[Guide here]()|For the application launcher| |Picom|picom-ibhagwan-gitaur|[Guide here]()|Compositor, needed for transparency/blur/effects/animations etc| ||||| ## TODO @@ -49,9 +50,35 @@ Some would say there are more features than a WM needs, I say you can never have - [x] Calendar widget (not interactive) - [x] Rofi application launcher and window switcher - [x] Volume / Brightness switcher +- [X] Dock +- [x] Systray + +Some stuff planned for the future + +- [ ] Calendar OSD +- [ ] GPU/CPU/RAM etc Temparature and Usage widget +- [ ] Extended volume and microphone control +- [ ] More bugs +- [ ] I3 like layout / manual tiling I've added various widgets you can choose or remove how you like it. __Including__:
Battery, Network (Wifi, Ethernet), Bluetooth, Volume, Keyboardlayout, Date (with Calendar), Time, Session options, Taglist, Tasklist, Layoutswitcher. +## Known bugs + +--- + +### Please note, the config could easily break since I can only test it on so many systems. Every installation is different + +### __If you encounter any bug or question you can't solve, feel free to open a new issue or PR__ + +- The dock may not work with most flatpaks, snaps, appimages and Icons wont work when a path instead of a program is specified +- The Volume and Backlight keys will be really laggy when changed too fast +- Not every program will use the Icon's pack icon in the taglist and tasklist +- Rounded corners have a transparent corner, this is because of picom +- The dock may or may not hide and show properly, sometimes even jitters +- The Volume OSD wont go over 100% even if the volume is higher(the regular widget works) +- The dock, Volume OSD and Backlight OSD all have very bad implementations and might cause performance issues +- The systay will stay even when empty since there is no way to check how many clients are in the systray