Update README.md

This commit is contained in:
Salim Zaidi 2023-11-06 06:39:40 +01:00 committed by GitHub
parent c8d987e39c
commit 00c79e02ce
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

396
README.md
View file

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