diff --git a/README.md b/README.md old mode 100644 new mode 100755 index 65585a9..f7fbab8 --- a/README.md +++ b/README.md @@ -1,2 +1,417 @@ -# debian-z -Debian/i3-wm Setup Script: Simplify installation and configuration for a clean, minimalistic, and visually appealing desktop environment. + +
+
+ + Logo + + +

Debian Minimal Setup with i3

+ +

+ Automate and Style Your Debian Setup with BlueNova! +
+

+ +## About The Project + +- **WM:** [i3-gaps](https://github.com/Airblader/i3) +- **OS:** [Debian Linux](https://debian.org) +- **Terminal:** [alacritty](https://github.com/alacritty/alacritty) +- **Shell:** [bash](https://wiki.debian.org/Bash) +- **Status Bar:** [polybar](https://github.com/polybar/polybar) +- **Compositor:** [picom](https://github.com/ibhagwan/picom) +- **Editor:** [vim](https://github.com/vim/vim) +- **Browser:** [Brave](https://github.com/brave/brave-browser) +- **File Manager:** [pcmanfm](https://github.com/lxde/pcmanfm) +- **Application Launcher:** [rofi](https://github.com/davatorium/rofi) + +--- + +| BlueNova | Dracula | Darkness | Nord | Horizon | Pink | +|--------------|--------------|--------------|--------------|--------------|--------------| +| ![Screenshot 1]([ign]/img/bluenova/s1.png) | ![Screenshot 2]([ign]/img/dracula/s1.png) | ![Screenshot 3]([ign]/img/darkness/s1.png) | ![Screenshot 3]([ign]/img/nord/s1.png) | ![Screenshot 3]([ign]/img/horizon/s1.png) | ![Screenshot 3]([ign]/img/pink/s1.png) | +| ![Screenshot 1]([ign]/img/bluenova/s2.png) | ![Screenshot 2]([ign]/img/dracula/s2.png) | ![Screenshot 3]([ign]/img/darkness/s2.png) | ![Screenshot 3]([ign]/img/nord/s2.png) | ![Screenshot 3]([ign]/img/horizon/s2.png) | ![Screenshot 3]([ign]/img/pink/s2.png) | +| ![Screenshot 1]([ign]/img/bluenova/s3.png) | ![Screenshot 2]([ign]/img/dracula/s3.png) | ![Screenshot 3]([ign]/img/darkness/s3.png) | ![Screenshot 3]([ign]/img/nord/s3.png) | ![Screenshot 3]([ign]/img/horizon/s3.png) | ![Screenshot 3]([ign]/img/pink/s3.png) | +| ![Screenshot 1]([ign]/img/bluenova/s4.png) | ![Screenshot 2]([ign]/img/dracula/s4.png) | ![Screenshot 3]([ign]/img/darkness/s4.png) | ![Screenshot 3]([ign]/img/nord/s4.png) | ![Screenshot 3]([ign]/img/horizon/s4.png) | ![Screenshot 3]([ign]/img/pink/s4.png) | + + +This project is a shell script that automates the installation process for a minimal Debian system, along with the i3 window manager and Ly Console Display Manager. It aims to provide an easy and efficient way to set up a Debian-based desktop environment with a Stylish lightweight and customizable window manager. + +The script installs the necessary packages and applications required for daily drive and a functional and beutiful i3wm setup, with Ly Console Display Manager, and other recommended utilities. It also configures various system settings to optimize the user experience and provides a clean minimal and stylish i3 configuration. + +## Pre-Installation + +To use this script and set up your Debian system with my i3 config and Ly, follow these steps: + +1. Install a fresh minimal Debian system. You can download the minimal installation ISO from the official Debian website and follow their installation guide. + +2. Once the base system is installed: +### Install git and vim +```bash +sudo apt install -y git vim +``` +### Clone this repo +```bash +git clone https://github.com/zedsalim/debian-z +cd debian-z +ls +.git config optional 1-software.sh 3-fonts.sh README.md +[ign] fonts theme 2-setup.sh 4-rice.sh run_me.sh +``` +### Categorization of the directories and the scripts +The apps.sh script is to install all the apps and the packages needed for a minimal Debian system, you can custumize it as you need. + +1. Scripts: +1-software.sh: A script responsible for install all the softwares and the packages needed for a minimal Debian system, **(you must see what inside it and you can custumize it as you need)**. +2-setup.sh: A script that handles the initial setup of the i3wm environment and Ly Console Display Manager. +3-fonts.sh: A script for font configuration and installation. +4-rice.sh: A script that performs further customization or "ricing" of Debian-Z i3wm environment. +run_me.sh: A script meant to be executed to apply the configurations and setups provided by other scripts **(this is the only script you need to run)** + + +2. Directories **(Do not modify)**: +config: The configuration file for the Debian-Z setup. +fonts: A directory containing font files used in the Debian-Z configuration. +theme: A directory with theme-related files. +optional: A folder containing optional configuration files and scripts that are not necessary for the basic setup (check them out). + +3. Other Files **(Delete them if you want)**: +README.md: A Markdown file serving as the main documentation or guide for this project. +[ign]: A folder that contains Essential Files for the README.md. + +**_Please note that the directories are marked as "Do not modify" to indicate that they contain important files and resources that should not be altered unless you have specific knowledge or intention to modify them._** + +## Installation +**To install this setup, simply run ./run_me.sh, enter your password, and wait for the installation to complete.** +```bash +./run_me.sh +``` + +## Post-Installation +> Press Super + Shift + h to view the Guide and read it all. +> NOTE: The 'Super' Key is the 'Windows' Key + +## 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 + bFocuses 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)

+
+ +## Contact + +* [Facebook](https://facebook.com/sxaliim) +* [Telegram](https://t.me/sxalim) +* salim.zaidi@univ-bouira.dz + +## Acknowledgments + +https://github.com/drewgrif/i3gaps-debian + +This script is built upon of the original script created by [drewgrif](https://github.com/drewgrif) . I would like to express my gratitude for his valuable contribution and the effort he put into developing the initial version. While I have made several tweaks and additions to suit my personal needs, the core functionality and inspiration behind this script stem from [drewgrif](https://github.com/drewgrif) work. + +I am thankful to the open-source community for providing a platform for collaboration and sharing of ideas. This project wouldn't have been possible without the collective efforts of developers and enthusiasts who continuously contribute to the improvement of tools and resources within the Linux ecosystem. + +Please note that any issues or limitations encountered in this modified script are solely my responsibility, and I encourage users to refer to the original script by [drewgrif](https://github.com/drewgrif) for a comprehensive understanding of its functionality and origins. + > The original script: [i3gaps-debian](https://github.com/drewgrif/i3gaps-debian) + + diff --git a/[ign]/img/bluenova/s1.png b/[ign]/img/bluenova/s1.png new file mode 100755 index 0000000..be9e08f Binary files /dev/null and b/[ign]/img/bluenova/s1.png differ diff --git a/[ign]/img/bluenova/s2.png b/[ign]/img/bluenova/s2.png new file mode 100755 index 0000000..beb9b7b Binary files /dev/null and b/[ign]/img/bluenova/s2.png differ diff --git a/[ign]/img/bluenova/s3.png b/[ign]/img/bluenova/s3.png new file mode 100755 index 0000000..2cb2cee Binary files /dev/null and b/[ign]/img/bluenova/s3.png differ diff --git a/[ign]/img/bluenova/s4.png b/[ign]/img/bluenova/s4.png new file mode 100755 index 0000000..e73c1d8 Binary files /dev/null and b/[ign]/img/bluenova/s4.png differ diff --git a/[ign]/logo.png b/[ign]/logo.png new file mode 100644 index 0000000..71e17d7 Binary files /dev/null and b/[ign]/logo.png differ