From 4a3f73a35035576970117f661bfcc358259cd6c2 Mon Sep 17 00:00:00 2001 From: elenapan Date: Sat, 11 Jul 2020 21:17:13 +0300 Subject: [PATCH] Update README with new theme release --- .assets/tipjar.png | Bin 0 -> 3681 bytes README.md | 175 +++++++++++++++++++++++++-------------------- 2 files changed, 99 insertions(+), 76 deletions(-) create mode 100644 .assets/tipjar.png diff --git a/.assets/tipjar.png b/.assets/tipjar.png new file mode 100644 index 0000000000000000000000000000000000000000..3a1c4972c3c1bd39d4fb2b81931d4a2e0587be13 GIT binary patch literal 3681 zcmeAS@N?(olHy`uVBq!ia0y~yVEDzrz+l6{#=yYfAG>@C0|R4Arn7T^r?ay{K~a8M zW=<*tgT}<#iMAex9b}Hi2QOVD%4*$Vk+Nb}gn($_6)lm4PAf#CN)2{?an86jVaW~) zu63;J_F}8~^v>nA;r~KHz<|0?fx-d z*PrOEc%4nc@>yUT+s&`d{|~;;Tl?q8j_D$O%y0GkJ{z*Mlr>geE!@{HyS$ExWqzaf z-k18<8(#WfTJ5V_#quSGS^T=M?@eaC@`iuv&St6MT$e;XRX+IJvrm)z%U!0qtK;%} zYvWR{U(I?Q@1?sH|idv^Z+d6{3nGb@}aYTMsj4~iVNByV>YhCGIY4A&Iq z{5;CQz`$AH5n0T@z%2~Ij105pNH8!ku$OrHy0SlE=N9BM%lLbaFFBn;w8vlG?p6ehSzq+?YH zYwxDrHCW|z{@hj_#xN#s*O?qFhut(c9Lw8WXR-(+EW*UkXx?okz~R$MpvN6YCXg1H)h$+ zXR^M$iScIqAhW^gMz}%;_cMk{x5+nOW#s1kI194m4BI?KgIqNMjz{e)52!3Yx##@F zTM^ZlocOOjInOYib2b-C;mH(*(-}tL{2`lHv%Q>bubx%ZnBdc4dp5&px^Q|K9?HI4UyMrav_nqL( zs;JCZwkSMzU&{ffszw11iF}=iGdm-HCRRqjVc+rgwZE(4arN-lb-nLn7q6c(+jL*# zwx*tzC-1(zI=gg@?FQ|%>-E3>bRT9Z$}5vQe`a^a8P1d{x3Kwp4)x?HF8`6LdO^1& z)gw2qiKl#_YSxy-m%p}&DGD51dEn53Wrthu?e^7Y=kZcy^Aw);z4-I`M}nOWrGNDW zKV`KhKAQbB(TTsRZQ|U^9g9MYy5w4Q#w_}XJ3rp^PxPvZk4t0(ZSpUt;^w%2b* zx!W;XOGKXk{jy-&?%yvq#r&N%eU8+$cONX;T^0P#?{9he*qB+#KFC^)HRyF=VfM@8 zPFBhNLJxilJH@NGb1#t;I&|sy-8_)PjwwB;biEM0TE}YH?!3weOYF?QuASai@^8EM z{}Vr4f{!HgzU6zi|Nk@3`{kQAH-B=j-q>?m!B&%VuUBta(BtpFUw)~|c$JfWe!ct8 zg75t`PJDv}phtCnb)*8SO0YZo*T1c|zI2`O)R|}0d-Cxm&ucF)u2QkFlh>O+TbYmjS~BmRZOPK@b8?G>ep_@l zc&8ndP;^ay;N=~7pP7rbQ%bi}O4ssOh~6BNR^4w>|3d!#T(C$oZ{D29GosU+c(Qz3 z7IS@>BviX-R?m@?bMqz~-qf_YvbLJ_^|$wZzpR(3&-`(E59^$%c7m?@^;%L>TijG9 zrkEA9SvIpy*4^{@^7lO(l4r-r%}!Ef-2b{Mm}hFx$vby0S3dvr+CXFK;xhTw&tndh zvTpt*SebI>my4WTKI3+O&5l=pSbF=e|1Z#GeL1t%MUJz1$-`$ai#5!apMF|6Ls9U? z9zAZUTe68Szf5Q~YP8!mneTl5`{nZ4`R)q?zWuh{_+-a%*X75Xg*+}~T=abPLGAMn zlX?T;`gX^zn5s2ti`9|`U;B5@{gZs!JjBH8 z#M6uOwFEmBC~;SP@2&psy#L1j+3Nql-_8FwFWc_Ff?6^&^TxIB1oHoEn7ZlMuMK~) z)#si&dpUjb{8`uLn(L<#73N48GZy%S+E`%8<8!iE_y&n+shEXlq(A!qacm5t@)VISv9 zW&2Ne4=M~lsPpXEoMWrrd)>UGBR!G%i8sq36;6is%a&^IHh-Efm3Q}x=aJ<1a<|T_ zw`WJh7b#mFJMd*;)Y7DvGg%}Gzkm95uk}VtnLQORC%yY~ z`IzhdJ>MQbPk!xh6ZJE9e)8Ek`SW3+PN7R>t;M$1 z)BN4v&fRHq@ul6hoDUR4>du;coMT**%OMlnrPw#(jHvQALgSH$0FS=OK z-K+a*ibL-PW{bVai`@)fevO%9xWjwD_ornoOQWsa>)aGeKKccxSBEIgpO+%UpZsQJ zAk(I|cXrg+J~De%nzHKf-m^JCuX${8di3y60{Xcex+!r z)+L_K+H-gBUolv5BJl&S&ZHpG%f5P6Q>ErE{Li>cx1ImPm2Vd-r`Lz2AKtWhlBjXl zVYmCGlXjhdCVg;2VA}S`*?xQ6%uikA;?Matc3o{Dq-ma&D^$;rQaXB%s`Cs1cr z;qN^;8^Vfjn=gJH_N!I)_K(}o)@QuP5S}D0Yv$B{eg`j$((+S%htKh?`}f9HPRF9X z`_pm*#giR=YmYttT=->2Ggmb4`JDAVvny{sJ6HDa&)4O547PR{Usg{rQ&}`sWml72 zn$+#vH;dnJ{k*i?de_}H_G`cH*?sxwykvLH z?Qb8yt@*0U8z`&2#^_$XR5o2}A__zQx*oXwS|qC04B$A5FisVA;#q#ms9Q+Y)E8Fm5w3 zFIcj6Yqj-CA=dJF#?xPOr7a5etaUq8ZhnP(@lpM3C*j1&(+|Gre%;dhHUWtKhv*@C2shU5}ToN)y|3k6H`IN4X=57wiH`0HQg`t$cS=;O0tG1b2pu6vJOLf<|xBvFvef(%`V%eq-t#295eJcz4%2py} zI?1c``gPaIo10hdI=tprzNU0`?xKW8lilB%WzRn<{CD5>&BeO<%-=b8bFw72g}*U- z{dXcC&z1ufq8}PJ%ylqO`=PMnX2+M^vZpWJx{+rxbL|0@giRY3I|yvA;j>BH9?8!a z`NDCdxrFbtS{9oN92>b=K5Bm2e=GMI<99{=T?cPnycLmcGIMpKNs7omPX!6(vtQNO zgeyaw_*dRM%_wW&ej{8#qBM?CPIARgxli zIy-;seUg!TC(UH$epaCdr^NEcgd-8`cjPnY**r6?T7RpSbA!-EyEp|2Kd(m9z0MH!k#w>uA@_yemO#;}jtA!%yc%3jTwtH;Ai#WzV@Lh1gzb^vkG)!S zSWHCQ`uZd;5oTi!pVLo;JC4rtQfON3G-ahj+Yino);UT7sw>+Za$3PHcfQkp3;#1m Yul+0iU;Xh<1_lNOPgg&ebxsLQ0L)kr^8f$< literal 0 HcmV?d00001 diff --git a/README.md b/README.md index 10c29f7..316b395 100644 --- a/README.md +++ b/README.md @@ -10,12 +10,13 @@ +

### Thanks for dropping by! -img +img This is my personal collection of configuration files. @@ -25,21 +26,26 @@ The [setup section](#setup) will guide you through the installation process. Here are some details about my setup: -+ **WM**: [AwesomeWM](https://github.com/awesomeWM/awesome/) -+ **OS**: Ubuntu 18.04 ++ **WM**: [AwesomeWM](https://github.com/awesomeWM/awesome/) 💙 config included! ++ **OS**: Arch Linux + **Shell**: [zsh](https://wiki.archlinux.org/index.php/Zsh) -+ **Terminal**: [kitty](https://github.com/kovidgoyal/kitty/) -+ **Editor**: [Neovim](https://github.com/neovim/neovim/) ++ **Terminal**: [kitty](https://github.com/kovidgoyal/kitty/) 💙 config included! ++ **Editor**: [Neovim](https://github.com/neovim/neovim/) 💙 config included! + **Org editor**: [Doom Emacs](https://github.com/hlissner/doom-emacs/) + **File Manager**: [Thunar](https://git.xfce.org/xfce/thunar/) -+ **Launcher**: [rofi](https://github.com/davatorium/rofi/) ++ **Launcher**: [rofi](https://github.com/davatorium/rofi/) 💙 config included! + **Browser**: Firefox -## New features +## New stuff -| Anti-aliased rounded corners | App drawer | Lock screen - [See it in action](https://streamable.com/d2t8f) | -| --- | --- | --- | -| ![Screenshot](https://i.imgur.com/PXwQc87.png) | ![Screenshot](https://i.imgur.com/Z5rYUvI.png) | ![Screenshot](https://i.imgur.com/BL0USAH.png) | +- New release: Code name `amarena` +- Brand new sidebar theme +- Revamped dashboard: now with corona stats for your country of choice +- Mini window switcher / manager activated with super + tab. Check out all its features [here](https://github.com/elenapan/dotfiles/wiki/Desktop-elements#window-switcher) +- Custom mouse-friendly `ncmpcpp` UI +- Adorable battery indicator +- Support for [PAM authentication](https://wiki.archlinux.org/index.php/PAM) through the built-in lock screen +- Cleaner code (but no one will notice) ## Setup @@ -47,14 +53,14 @@ Here are the instructions you should follow to replicate my AwesomeWM setup. 1. Install the [git version of AwesomeWM](https://github.com/awesomeWM/awesome/). - Build instructions [here](https://github.com/awesomeWM/awesome/#building-and-installation). - **Arch users** can use the [awesome-git AUR package](https://aur.archlinux.org/packages/awesome-git/). ```shell yay -S awesome-git ``` -2. Install needed software and enable services + **For other distros**, build instructions are [here](https://github.com/awesomeWM/awesome/#building-and-installation). + +2. Install dependencies and enable services *If you are curious, [click here](https://github.com/elenapan/dotfiles/wiki/Detailed-dependency-table) to see a table of dependencies and why they are needed.* @@ -117,7 +123,7 @@ Here are the instructions you should follow to replicate my AwesomeWM setup. ``` 4. Install my AwesomeWM configuration files - + ```shell git clone https://github.com/elenapan/dotfiles cd dotfiles @@ -125,37 +131,23 @@ Here are the instructions you should follow to replicate my AwesomeWM setup. cp -r config/awesome ~/.config/awesome ``` - + *(Optional but recommended)* Improved lock screen security - - Instead of authenticating with a custom password stored in plain text inside your configuration files, it is possible to use [PAM](https://wiki.archlinux.org/index.php/PAM) in order to do it using your regular user password in a secure way. [lua-pam](https://github.com/RMTT/lua-pam) allows us to use PAM from within AwesomeWM. - - You will need to install the `pam` package through your distribution's package manager and then follow the [instructions to build lua-pam](https://github.com/RMTT/lua-pam). - After building it, you can simply copy the resulting `liblua_pam.so` file to your configuration directory, like so: - - ```shell - cp liblua_pam.so ~/.config/awesome/ - ``` - - If you do not want to install it, no worries! - You can set a custom lock screen password in your user preferences (see next section). - - The lock screen will automatically determine the authentication method depending on whether `lua-pam` is installed or not. - 4. Configure stuff The relevant files are inside your `~/.config/awesome` directory. - + User preferences - + + User preferences and default applications + In `rc.lua` there is a *User variables and preferences* section where user preferences and default applications are defined. You should change those to your liking. Probably the most important change you can make is to set your `terminal`. + For more sophisticated control over your apps, check out `apps.lua` + Note: For the weather widgets to work, you will also need to create an account on [openweathermap](https://openweathermap.org), get your key, look for your city ID, and set `openweathermap_key` and `openweathermap_city_id` accordingly. - + + Have a general idea of what my keybinds do My keybinds will most probably not suit you completely, but on your first login you might need to know how to navigate the desktop. - + See the [keybinds](#keybinds) section for more details. You can edit `keys.lua` to configure your keybinds. @@ -166,19 +158,23 @@ Here are the instructions you should follow to replicate my AwesomeWM setup. Congratulations, at this point you should be ready to log out of your current desktop and into AwesomeWM. - Your login screen should have a button that lets you change between available desktop sessions. + Your login screen should have a button that lets you change between available desktop sessions. If not, [click here](https://github.com/elenapan/dotfiles/wiki/Troubleshooting#i-cannot-find-the-login-screen-button-that-lets-me-login-with-awesomewm) to find out how to fix it. + + Try it, play with it, enjoy it. + Consider checking out the [Advanced setup](https://github.com/elenapan/dotfiles/wiki/Advanced-setup) in order to enable and configure various components that are not needed to use the desktop, but provide a better experience. + 6. *(Optional)* Eye-candy + Set the wallpaper - ```sh + ```shell feh --bg-fill /path/to/your/wallpaper ``` + Load a colorscheme - - ```sh + + ```shell xrdb -merge /path/to/colorscheme ``` @@ -231,10 +227,16 @@ After setting up my AwesomeWM configuration, inside `~/.config/awesome` you will + 🎀 `decorations` directory - In this directoy you can find window decoration (titlebar) styles. + In this directory you can find window decoration (titlebar) styles. They affect the layout of the titlebar and the titlebar buttons (e.g. close, maximize, minimize). - + + Optionally, they may implement more complex decorations, using multiple titlebars around the window to create a certain look (e.g. double borders) or achieve anti-aliased window corners. + + Finally, some clients may have their own special titlebars added to them in order to simulate a custom UI. + For now, a custom `mpd` UI has been implemented. + + The `decorations` module also includes helper functions that generate titlebar buttons, in case you do not have/want image buttons. + 💎 `elemental` directory @@ -242,7 +244,7 @@ After setting up my AwesomeWM configuration, inside `~/.config/awesome` you will Elements with multiple available themes have their own directory. For example: + In `elemental/bar` you can find a `.lua` file for each available bar or bar group. - + Multiple bars can be created in one file. Every bar theme provides the global functions `wibars_toggle()` and `tray_toggle()` which you can bind to any keys you want. @@ -253,7 +255,7 @@ After setting up my AwesomeWM configuration, inside `~/.config/awesome` you will + 💬 `notifications` directory This directory includes notification daemons that trigger notifications for various desktop events such as volume or brightness change. - Also it includes notification themes that define the layout of the notification. + Also it includes notification themes that define the layout of the notification contents. + 🍜 `noodle` directory: Contains widgets that usually take up more than 50 lines of code. @@ -274,43 +276,64 @@ After setting up my AwesomeWM configuration, inside `~/.config/awesome` you will I use super AKA Windows key as my main modifier. #### Keyboard -+ super + enter - Spawn terminal -+ super + shift + enter - Spawn floating terminal -+ super + d - Launch rofi -+ super + shift + q - Close client -+ super + control + space - Toggle floating client -+ super + [1-0] - View tag AKA change workspace (for you i3 folks) -+ super + shift + [1-0] - Move focused client to tag -+ super + s - Tiling layout -+ super + shift + s - Floating layout -+ super + w - Maximized / Monocle layout -+ super + [arrow keys] or super + [hjkl] - Change focus by direction -+ super + shift + [arrow keys] or super + shift + [hjkl] - Move client by direction. Move to edge if it is floating. -+ super + control + [arrow keys] or super + control + [hjkl] - Resize -+ super + f - Toggle fullscreen -+ super + m - Toggle maximize -+ super + n - Minimize -+ super + shift + n - Restore minimized -+ super + c - Center floating client -+ super + u - Jump to urgent client (or back to last tag if there is no such client) -+ super + shift + b - Toggle bar -+ super + = - Toggle tray -+ *... And many many more.* +| Keybind | Action | +| --- | --- | +| super + enter | Spawn terminal | +| super + shift + enter | Spawn floating terminal | +| super + d | Launch rofi | +| super + shift + q | Close client | +| super + control + space | Toggle floating client | +| super + [1-0] | View tag AKA change workspace (for you i3 folks) | +| super + shift + [1-0] | Move focused client to tag | +| super + s | Tiling layout | +| super + shift + s | Floating layout | +| super + w | Maximized / Monocle layout | +| super + [arrow keys] | Change focus by direction | +| super + [hjkl] | ^ | +| super + shift + [arrow keys] | Move client by direction. Move to edge if it is floating. | +| super + shift + [hjkl] | ^ | +| super + control + [arrow keys] | Resize client | +| super + control + [hjkl] | ^ | +| super + f | Toggle fullscreen | +| super + m | Toggle maximize | +| super + n | Minimize | +| super + shift + n | Restore minimized | +| super + c | Center floating client | +| super + u | Jump to urgent client (or back to last tag if there is no such client) | +| super + b | Toggle bar | +| super + = | Toggle tray | -#### Mouse on desktop -+ `left click` - Dismiss all notifications, close sidebar and main menu -+ `double left click` - Jump to urgent client (or back to last tag if there is no such client) -+ `right click` - App drawer -+ `middle click` - Dashboard -+ `scroll up/down` - Cycle through tags -+ `move to left/right edge` - Show sidebar +*... And many many more.* -#### Mouse on titlebars -+ `left click` - Focus and raise -+ `left click (drag)` - Move -+ `right click (drag)` - Resize -+ `middle click` - Close +#### Mouse on the desktop +| Mousebind | Action | +| --- | --- | +| `left click` | Dismiss all notifications, close sidebar and main menu | +| `double left click` | Jump to urgent client (or back to last tag if there is no such client) | +| `right click` | App drawer | +| `middle click` | Dashboard | +| `scroll up/down` | Cycle through tags | +| `move to screen edge` | Show sidebar | + +#### Mouse on window titlebars +| Mousebind | Action | +| --- | --- | +| `left click` | Focus and raise | +| `left click (drag)` | Move | +| `right click (drag)` | Resize | +| `middle click` | Close | ### Notes If you have any questions or issues, first check if you can find your answer in the [wiki](https://github.com/elenapan/dotfiles/wiki). Then you can search in the repository's [issues](https://github.com/elenapan/dotfiles/issues) or make a new issue. + +### Tipjar +If you enjoy my themes and would like to show your appreciation, you may tip me here. + +It is never required but always appreciated. + +Thank you from the bottom of my heart! 💙 + +- [**Patreon**](https://www.patreon.com/elenapan) +- **Ethereum**: 0x831539d94155C797f786e99f1D061BEc7F11bD38 +- **Bitcoin**: 12j3D4KR94LY7Svvmp3KzGbfGC4YCZkCLe