From 00c79e02ce228c8256242673295310aaf02a84f5 Mon Sep 17 00:00:00 2001 From: Salim Zaidi <121177411+zedsalim@users.noreply.github.com> Date: Mon, 6 Nov 2023 06:39:40 +0100 Subject: [PATCH] Update README.md --- README.md | 396 ++++++++++++++---------------------------------------- 1 file changed, 104 insertions(+), 292 deletions(-) diff --git a/README.md b/README.md index b1fd143..b6e6712 100755 --- a/README.md +++ b/README.md @@ -96,295 +96,107 @@ README.md: A Markdown file serving as the main documentation or guide for this p ## Usage > The Super key is the Windows key

Keybindings:

- 
-    
Window Manager Keybindings:

-    
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-    
KeybindingAction
super + shift + hOpens this Guide
super + EscapeReloads sxhkd config
super + qCloses the current window
super + shift + cReloads the i3 window manager configuration
super + shift + rRestarts the i3 window manager
super + shift + qExits i3 window manager

-    
Application Keybindings:

-    
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-    
KeybindingAction
super + Return (Enter)Launches alacritty terminal
super + shift + Return (Enter)Launches alacritty terminal in floating mode
super + pOpens rofi application
alt + wOpens rofi (show mode)
super + nOpens pcmanfm file manager
super + rOpens ranger file manager
super + gOpens Github Desktop (not installed by default)
super + wLaunches Brave Browser
super + cLaunches VSCodium
super + dLaunches Discord (not installed by default)
super + tLaunches Telegram Desktop
Print (Impr écran Syst)Opens flameshot screenshot tool (GUI mode)

-    
Audio Keybindings:

-    
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-    
KeybindingAction
XF86AudioMuteToggles audio mute
XF86AudioLowerVolumeDecreases audio volume by 2%
XF86AudioRaiseVolumeIncreases audio volume by 2%

-    
Brightness Keybindings:

-    
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-    
KeybindingAction
XF86MonBrightnessDownDecreases audio volume by 10%
XF86MonBrightnessUpIncreases audio volume by 10%
 
-    
i3 Window Manager Keybindings:

-    
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-    
KeybindingAction
super + vSplits the current container vertically
super + hSplits the current container horizontally
super + fToggles fullscreen mode for the current container
super + shift + fToggles floating mode for the current container
super + control + spaceToggles focus between tiling and floating mode
super + alt + aFocuses on the parent container
alt + shift + sChange container layout to stacked
alt + shift + tChange container layout to tabbed
alt + shift + eChange container layout to toggle split

-    
Workspace Keybindings:

-    
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-    
KeybindingAction
super + [1->9,0]Switches to the specified workspace
super + shift + [1->9,0]Moves the current container to the specified workspace

-    
Window Movement Keybindings:

-    
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-    
KeybindingAction
super + [h, j, k, l]Focuses on the window in the specified direction
super + shift + [h, j, k, l]Moves the window in the specified direction
super + [Left, Down, Up, Right]Focuses on the window in the specified direction
super + shift + [Left, Down, Up, Right]Moves the window in the specified direction
super + tabFocuses on the last two workspaces back and forth

-    
Additional Keybindings:

-    
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-    
KeybindingAction
alt + x (Where I keep all the courses and videos I need to learn from)Opens ranger in ~/Downloads/Watch (not created by default)
alt + cOpens the confige files that i edit frequently
alt + tChange the theme on the fly
alt + bOpens my bookmarks (add yours inside ~/config/bookmarks.txt)
alt + y (you must copy first the URL of a youtube video)Script that plays youtube videos using the mpv
alt + s (Create your own schedule in ~/Pictures/schedule.png)Opens my Work/Studies Schedule
F1 (Add your wallpapers in ~/.config/wallpapers/)Changing the wallpaper for the main monitor
F2Changing the wallpaper for two monitors
 
-    
Gaps Keybindings:

-    
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-    
KeybindingAction
super + shift + nAdjusts inner and outer gaps simultaneously
super + xIncreases outer gaps by 5
super + shift + xDecreases outer gaps by 5
super + zIncreases inner gaps by 5
super + shift + zDecreases inner gaps by 5
super + ctrl + [Left, Down, Up, Right]Resizes the current window

-    
System Keybindings:

-    
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-    
KeybindingAction
super + shift + bReboots the system (sudo reboot)
super + shift + sShuts down the system (sudo shutdown now)

-
+ ### Window Manager Keybindings: + +| Keybinding | Action | +| ----------------- | ------------------------------------------- | +| super + shift + h | Opens this Guide | +| super + Escape | Reloads sxhkd config | +| super + q | Closes the current window | +| super + shift + c | Reloads the i3 window manager configuration | +| super + shift + r | Restarts the i3 window manager | +| super + shift + q | Exits i3 window manager | + +### Application Keybindings: + +| Keybinding | Action | +| ------------------------------ | ----------------------------------------------- | +| super + Return (Enter) | Launches alacritty terminal | +| super + shift + Return (Enter) | Launches alacritty terminal in floating mode | +| super + p | Opens rofi application | +| alt + w | Opens rofi (show mode) | +| super + n | Opens pcmanfm file manager | +| super + r | Opens ranger file manager | +| super + g | Opens Github Desktop (not installed by default) | +| super + w | Launches Brave Browser | +| super + c | Launches VSCodium | +| super + d | Launches Discord (not installed by default) | +| super + t | Launches Telegram Desktop | +| Print (Impr écran Syst) | Opens flameshot screenshot tool (GUI mode) | + +### Audio Keybindings: + +| Keybinding | Action | +| -------------------- | ---------------------------- | +| XF86AudioMute | Toggles audio mute | +| XF86AudioLowerVolume | Decreases audio volume by 2% | +| XF86AudioRaiseVolume | Increases audio volume by 2% | + +### Brightness Keybindings: + +| Keybinding | Action | +| --------------------- | ----------------------------- | +| XF86MonBrightnessDown | Decreases audio volume by 10% | +| XF86MonBrightnessUp | Increases audio volume by 10% | + +### i3 Window Manager Keybindings: + +| Keybinding | Action | +| ----------------------- | ------------------------------------------------- | +| super + v | Splits the current container vertically | +| super + h | Splits the current container horizontally | +| super + f | Toggles fullscreen mode for the current container | +| super + shift + f | Toggles floating mode for the current container | +| super + control + space | Toggles focus between tiling and floating mode | +| super + alt + a | Focuses on the parent container | +| alt + shift + s | Change container layout to stacked | +| alt + shift + t | Change container layout to tabbed | +| alt + shift + e | Change container layout to toggle split | + +### Workspace Keybindings: + +| Keybinding | Action | +| -------------------------- | ------------------------------------------------------ | +| super + \[1->9,0\] | Switches to the specified workspace | +| super + shift + \[1->9,0\] | Moves the current container to the specified workspace | + +### Window Movement Keybindings: + +| Keybinding | Action | +| ----------------------------------------- | ------------------------------------------------- | +| super + \[h, j, k, l\] | Focuses on the window in the specified direction | +| super + shift + \[h, j, k, l\] | Moves the window in the specified direction | +| super + \[Left, Down, Up, Right\] | Focuses on the window in the specified direction | +| super + shift + \[Left, Down, Up, Right\] | Moves the window in the specified direction | +| super + tab | Focuses on the last two workspaces back and forth | + +### Additional Keybindings: + +| Keybinding | Action | +| ---------------------------------------------------------------------- | ------------------------------------------------------------ | +| alt + x (Where I keep all the courses and videos I need to learn from) | Opens ranger in ~/Downloads/Watch (not created by default) | +| alt + c | Opens the config files that I edit frequently | +| alt + t | Change the theme on the fly | +| alt + b | Opens my bookmarks (add yours inside ~/config/bookmarks.txt) | +| alt + y (you must copy first the URL of a youtube video) | Script that plays youtube videos using the mpv | +| alt + s (Create your own schedule in ~/Pictures/schedule.png) | Opens my Work/Studies Schedule | +| F1 (Add your wallpapers in ~/.config/wallpapers/) | Changing the wallpaper for the main monitor | +| F2 | Changing the wallpaper for two monitors | + +### Gaps Keybindings: + +| Keybinding | Action | +| ---------------------------------------- | ------------------------------------------- | +| super + shift + n | Adjusts inner and outer gaps simultaneously | +| super + x | Increases outer gaps by 5 | +| super + shift + x | Decreases outer gaps by 5 | +| super + z | Increases inner gaps by 5 | +| super + shift + z | Decreases inner gaps by 5 | +| super + ctrl + \[Left, Down, Up, Right\] | Resizes the current window | + +### System Keybindings: + +| Keybinding | Action | +| ----------------- | ----------------------------------------- | +| super + shift + b | Reboots the system (sudo reboot) | +| super + shift + s | Shuts down the system (sudo shutdown now) |